Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/gpio_irq_api.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

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