Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

hal/gpio_irq_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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