add file

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,4 +1,4 @@
-# io_input_filter IO输入滤波软件包。测试
+# io_input_filter IO输入滤波软件包
 
 ## 1 介绍
 

SConscript

@@ -0,0 +1,17 @@
+
+import os
+from building import *
+
+cwd = GetCurrentDir()
+
+src = Split('''
+io_input_filter.c
+''')
+
+# src += ['io_input_filter_example.c']
+
+path = [cwd]
+
+group = DefineGroup('io_input_filter', src, depend = ['PKG_USING_IO_INPUT_FILTER'], CPPPATH = path)
+
+Return('group')

io_input_filter.c

@@ -0,0 +1,162 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2022-07-04     lizd       the first version
+ */
+
+#include "io_input_filter.h"
+
+#define DBG_TAG "iif"
+#define DBG_LVL DBG_INFO
+#include <rtdbg.h>
+
+static struct io_input_filter *s_iif_head = RT_NULL;
+static rt_timer_t s_iif_timer = RT_NULL;
+
+static rt_err_t _iif_initialize(io_input_filter_t iif, rt_base_t pin);
+static void _iif_period_task(void *parameter);
+
+
+#ifdef RT_USING_HEAP
+io_input_filter_t iif_register(rt_base_t pin)
+{
+    io_input_filter_t iif;
+
+    iif = rt_malloc(sizeof(struct io_input_filter));
+    if (iif == RT_NULL)
+    {
+        LOG_E("iif_register() failed: no free memory was found!");
+        return RT_NULL;
+    }
+
+    if(_iif_initialize(iif, pin) != RT_EOK)
+    {
+        return RT_NULL;
+    }
+
+    return iif;
+}
+#endif /* #endif RT_USING_HEAP */
+
+rt_err_t iif_init(io_input_filter_t iif, rt_base_t pin)
+{
+    return _iif_initialize(iif, pin);
+}
+
+static rt_err_t _iif_initialize(io_input_filter_t iif, rt_base_t pin)
+{
+    // Initialize iif structure, Must be initialized before appending list,
+    // Otherwise, May cause scheduled tasks to execute uninitialized parameters
+    iif->next = RT_NULL;
+    iif->pin_status = PIN_LOW;
+    iif->filter_counts = 0;
+    iif->pin_id = pin;
+    rt_pin_mode(pin, PIN_MODE_INPUT);
+
+    // Append to iif list
+    if(s_iif_head == RT_NULL)
+    {
+        s_iif_head = iif;
+        LOG_I("list head: 0x%08X", s_iif_head);
+    }
+    else
+    {
+        struct io_input_filter *list = s_iif_head;
+        while(1)
+        {
+            if(list->next == RT_NULL)
+            {
+                list->next = iif;
+                LOG_I("iif list:  0x%08X -> 0x%08X", list, list->next);
+                break;
+            }
+            list = list->next;
+        }
+    }
+
+    // Create A Timer Task
+    if(s_iif_timer == RT_NULL)
+    {
+        s_iif_timer = rt_timer_create("iif task", _iif_period_task,
+                            RT_NULL, IIF_PERIOD, RT_TIMER_FLAG_PERIODIC);
+        if(s_iif_timer != RT_NULL)
+        {
+            rt_timer_start(s_iif_timer);
+            LOG_I("iif task start.");
+        }
+        else
+        {
+            LOG_E("iif task timer create failed!");
+            return RT_ERROR;
+        }
+    }
+
+    return RT_EOK;
+}
+
+uint8_t iif_read(struct io_input_filter *iif)
+{
+    RT_ASSERT(iif != RT_NULL);
+
+    return iif->pin_status;
+}
+
+static void io_input_filter_poll(void)
+{
+    struct io_input_filter *list = RT_NULL;
+
+    for(list = s_iif_head; list != NULL; list = list->next)
+    {
+        // IO处于低电平状态
+        if(rt_pin_read(list->pin_id) == PIN_LOW)
+        {
+            if(list->pin_status == PIN_HIGH)
+            {
+                if(list->filter_counts > 0)
+                {
+                    list->filter_counts--;
+                }
+                else
+                {
+                    list->pin_status = PIN_LOW;
+                    LOG_I("iif 0x%08X, pin status changed: %d", list, list->pin_status);
+                }
+            }
+            else
+            {
+                list->filter_counts = 0;
+            }
+        }
+        else
+        {
+            if(list->pin_status == PIN_LOW)
+            {
+                if(list->filter_counts < IIF_TIMES)
+                {
+                    list->filter_counts++;
+                }
+                else
+                {
+                    list->pin_status = PIN_HIGH;
+                    LOG_I("iif 0x%08X, pin status changed: %d", list, list->pin_status);
+                }
+            }
+            else
+            {
+                list->filter_counts = IIF_TIMES;
+            }
+        }
+
+        LOG_D("iif 0x%08X, filter_counts %d, pin_status %d", list, list->filter_counts, list->pin_status);
+    }
+}
+
+static void _iif_period_task(void *parameter)
+{
+    io_input_filter_poll();
+}
+

io_input_filter.h

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2022-07-04     lizd       the first version
+ */
+#ifndef _IO_INPUT_FILTER_H_
+#define _IO_INPUT_FILTER_H_
+
+#include <rtthread.h>
+#include <rtdevice.h>
+#include <drv_common.h>
+
+/* Input Filter Times */
+#ifndef IIF_TIMES
+#define IIF_TIMES     10
+#endif
+
+/* Input Filter Period */
+#ifndef IIF_PERIOD
+#define IIF_PERIOD    5
+#endif
+
+
+struct io_input_filter
+{
+    uint8_t pin_id;
+    uint8_t pin_status;
+    uint8_t filter_counts;
+    struct io_input_filter *next;
+};
+typedef struct io_input_filter *io_input_filter_t;
+
+
+io_input_filter_t iif_register(rt_base_t pin);
+rt_err_t iif_init(io_input_filter_t iif, rt_base_t pin);
+uint8_t iif_read(struct io_input_filter *iif);
+
+#endif /* PACKAGES_IO_INPUT_FILTER_H_ */

io_input_filter_example.c

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2006-2021, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2022-07-05     lizd       the first version
+ */
+
+#include "io_input_filter.h"
+
+
+io_input_filter_t g_input_1 = RT_NULL;
+io_input_filter_t g_input_2 = RT_NULL;
+io_input_filter_t g_input_3 = RT_NULL;
+
+struct io_input_filter g_input_4;
+struct io_input_filter g_input_5;
+
+void iif_example(void *para)
+{
+    // Created in the heap
+    g_input_1 = iif_register(GET_PIN(B, 0));
+    g_input_2 = iif_register(GET_PIN(B, 1));
+    g_input_3 = iif_register(GET_PIN(B, 2));
+
+    // Created using static variables
+    iif_init(&g_input_4, GET_PIN(D, 10));
+    iif_init(&g_input_5, GET_PIN(D, 11));
+
+    while(1)
+    {
+        if(iif_read(g_input_1) == 1)
+        {
+            rt_kprintf("input_1 status: High\n");
+        }
+
+        if(iif_read(g_input_2) == 1)
+        {
+            rt_kprintf("input_2 status: High\n");
+        }
+
+        if(iif_read(g_input_3) == 1)
+        {
+            rt_kprintf("input_3 status: High\n");
+        }
+
+        if(iif_read(&g_input_4) == 1)
+        {
+            rt_kprintf("input_4 status: High\n");
+        }
+
+        if(iif_read(&g_input_5) == 1)
+        {
+            rt_kprintf("input_5 status: High\n");
+        }
+
+        rt_kprintf("\n");
+        rt_thread_mdelay(100);
+    }
+}
+
+MSH_CMD_EXPORT(iif_example, io input filter example);
+
+