EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/gpio_irq_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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