BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/gpio_irq_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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