Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/gpio_irq_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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