Gan likun / mbed-dev

00

hal/gpio_irq_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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