Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/gpio_irq_api.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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