Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/gpio_irq_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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