mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/gpio_irq_api.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
128:9bcdf88f62b0 
mbed library release version 165

Who changed what in which revision?

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