mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/gpio_irq_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
149:156823d33999 
mbed library release version 165

Who changed what in which revision?

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