Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/gpio_irq_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:20e0c61e0684 1
ganlikun 0:20e0c61e0684 2 /** \addtogroup hal */
ganlikun 0:20e0c61e0684 3 /** @{*/
ganlikun 0:20e0c61e0684 4 /* mbed Microcontroller Library
ganlikun 0:20e0c61e0684 5 * Copyright (c) 2006-2013 ARM Limited
ganlikun 0:20e0c61e0684 6 *
ganlikun 0:20e0c61e0684 7 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:20e0c61e0684 8 * you may not use this file except in compliance with the License.
ganlikun 0:20e0c61e0684 9 * You may obtain a copy of the License at
ganlikun 0:20e0c61e0684 10 *
ganlikun 0:20e0c61e0684 11 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:20e0c61e0684 12 *
ganlikun 0:20e0c61e0684 13 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:20e0c61e0684 14 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:20e0c61e0684 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:20e0c61e0684 16 * See the License for the specific language governing permissions and
ganlikun 0:20e0c61e0684 17 * limitations under the License.
ganlikun 0:20e0c61e0684 18 */
ganlikun 0:20e0c61e0684 19 #ifndef MBED_GPIO_IRQ_API_H
ganlikun 0:20e0c61e0684 20 #define MBED_GPIO_IRQ_API_H
ganlikun 0:20e0c61e0684 21
ganlikun 0:20e0c61e0684 22 #include "device.h"
ganlikun 0:20e0c61e0684 23
ganlikun 0:20e0c61e0684 24 #if DEVICE_INTERRUPTIN
ganlikun 0:20e0c61e0684 25
ganlikun 0:20e0c61e0684 26 #ifdef __cplusplus
ganlikun 0:20e0c61e0684 27 extern "C" {
ganlikun 0:20e0c61e0684 28 #endif
ganlikun 0:20e0c61e0684 29
ganlikun 0:20e0c61e0684 30 /** GPIO IRQ events
ganlikun 0:20e0c61e0684 31 */
ganlikun 0:20e0c61e0684 32 typedef enum {
ganlikun 0:20e0c61e0684 33 IRQ_NONE,
ganlikun 0:20e0c61e0684 34 IRQ_RISE,
ganlikun 0:20e0c61e0684 35 IRQ_FALL
ganlikun 0:20e0c61e0684 36 } gpio_irq_event;
ganlikun 0:20e0c61e0684 37
ganlikun 0:20e0c61e0684 38 /** GPIO IRQ HAL structure. gpio_irq_s is declared in the target's HAL
ganlikun 0:20e0c61e0684 39 */
ganlikun 0:20e0c61e0684 40 typedef struct gpio_irq_s gpio_irq_t;
ganlikun 0:20e0c61e0684 41
ganlikun 0:20e0c61e0684 42 typedef void (*gpio_irq_handler)(uint32_t id, gpio_irq_event event);
ganlikun 0:20e0c61e0684 43
ganlikun 0:20e0c61e0684 44 /**
ganlikun 0:20e0c61e0684 45 * \defgroup hal_gpioirq GPIO IRQ HAL functions
ganlikun 0:20e0c61e0684 46 * @{
ganlikun 0:20e0c61e0684 47 */
ganlikun 0:20e0c61e0684 48
ganlikun 0:20e0c61e0684 49 /** Initialize the GPIO IRQ pin
ganlikun 0:20e0c61e0684 50 *
ganlikun 0:20e0c61e0684 51 * @param obj The GPIO object to initialize
ganlikun 0:20e0c61e0684 52 * @param pin The GPIO pin name
ganlikun 0:20e0c61e0684 53 * @param handler The handler to be attached to GPIO IRQ
ganlikun 0:20e0c61e0684 54 * @param id The object ID (id != 0, 0 is reserved)
ganlikun 0:20e0c61e0684 55 * @return -1 if pin is NC, 0 otherwise
ganlikun 0:20e0c61e0684 56 */
ganlikun 0:20e0c61e0684 57 int gpio_irq_init(gpio_irq_t *obj, PinName pin, gpio_irq_handler handler, uint32_t id);
ganlikun 0:20e0c61e0684 58
ganlikun 0:20e0c61e0684 59 /** Release the GPIO IRQ PIN
ganlikun 0:20e0c61e0684 60 *
ganlikun 0:20e0c61e0684 61 * @param obj The gpio object
ganlikun 0:20e0c61e0684 62 */
ganlikun 0:20e0c61e0684 63 void gpio_irq_free(gpio_irq_t *obj);
ganlikun 0:20e0c61e0684 64
ganlikun 0:20e0c61e0684 65 /** Enable/disable pin IRQ event
ganlikun 0:20e0c61e0684 66 *
ganlikun 0:20e0c61e0684 67 * @param obj The GPIO object
ganlikun 0:20e0c61e0684 68 * @param event The GPIO IRQ event
ganlikun 0:20e0c61e0684 69 * @param enable The enable flag
ganlikun 0:20e0c61e0684 70 */
ganlikun 0:20e0c61e0684 71 void gpio_irq_set(gpio_irq_t *obj, gpio_irq_event event, uint32_t enable);
ganlikun 0:20e0c61e0684 72
ganlikun 0:20e0c61e0684 73 /** Enable GPIO IRQ
ganlikun 0:20e0c61e0684 74 *
ganlikun 0:20e0c61e0684 75 * This is target dependent, as it might enable the entire port or just a pin
ganlikun 0:20e0c61e0684 76 * @param obj The GPIO object
ganlikun 0:20e0c61e0684 77 */
ganlikun 0:20e0c61e0684 78 void gpio_irq_enable(gpio_irq_t *obj);
ganlikun 0:20e0c61e0684 79
ganlikun 0:20e0c61e0684 80 /** Disable GPIO IRQ
ganlikun 0:20e0c61e0684 81 *
ganlikun 0:20e0c61e0684 82 * This is target dependent, as it might disable the entire port or just a pin
ganlikun 0:20e0c61e0684 83 * @param obj The GPIO object
ganlikun 0:20e0c61e0684 84 */
ganlikun 0:20e0c61e0684 85 void gpio_irq_disable(gpio_irq_t *obj);
ganlikun 0:20e0c61e0684 86
ganlikun 0:20e0c61e0684 87 /**@}*/
ganlikun 0:20e0c61e0684 88
ganlikun 0:20e0c61e0684 89 #ifdef __cplusplus
ganlikun 0:20e0c61e0684 90 }
ganlikun 0:20e0c61e0684 91 #endif
ganlikun 0:20e0c61e0684 92
ganlikun 0:20e0c61e0684 93 #endif
ganlikun 0:20e0c61e0684 94
ganlikun 0:20e0c61e0684 95 #endif
ganlikun 0:20e0c61e0684 96
ganlikun 0:20e0c61e0684 97 /** @}*/
ganlikun 0:20e0c61e0684 98