Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/gpio_irq_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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