TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/hal/gpio_irq_api.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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