mirror of https://github.com/ARMmbed/mbed-os.git
				
				
				
			
		
			
				
	
	
		
			98 lines
		
	
	
		
			2.2 KiB
		
	
	
	
		
			C
		
	
	
			
		
		
	
	
			98 lines
		
	
	
		
			2.2 KiB
		
	
	
	
		
			C
		
	
	
 | 
						|
/** \addtogroup hal */
 | 
						|
/** @{*/
 | 
						|
/* mbed Microcontroller Library
 | 
						|
 * Copyright (c) 2006-2013 ARM Limited
 | 
						|
 *
 | 
						|
 * Licensed under the Apache License, Version 2.0 (the "License");
 | 
						|
 * you may not use this file except in compliance with the License.
 | 
						|
 * You may obtain a copy of the License at
 | 
						|
 *
 | 
						|
 *     http://www.apache.org/licenses/LICENSE-2.0
 | 
						|
 *
 | 
						|
 * Unless required by applicable law or agreed to in writing, software
 | 
						|
 * distributed under the License is distributed on an "AS IS" BASIS,
 | 
						|
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
						|
 * See the License for the specific language governing permissions and
 | 
						|
 * limitations under the License.
 | 
						|
 */
 | 
						|
#ifndef MBED_GPIO_IRQ_API_H
 | 
						|
#define MBED_GPIO_IRQ_API_H
 | 
						|
 | 
						|
#include "device.h"
 | 
						|
 | 
						|
#if DEVICE_INTERRUPTIN
 | 
						|
 | 
						|
#ifdef __cplusplus
 | 
						|
extern "C" {
 | 
						|
#endif
 | 
						|
 | 
						|
/** GPIO IRQ events
 | 
						|
 */
 | 
						|
typedef enum {
 | 
						|
    IRQ_NONE,
 | 
						|
    IRQ_RISE,
 | 
						|
    IRQ_FALL
 | 
						|
} gpio_irq_event;
 | 
						|
 | 
						|
/** GPIO IRQ HAL structure. gpio_irq_s is declared in the target's HAL
 | 
						|
 */
 | 
						|
typedef struct gpio_irq_s gpio_irq_t;
 | 
						|
 | 
						|
typedef void (*gpio_irq_handler)(uint32_t id, gpio_irq_event event);
 | 
						|
 | 
						|
/**
 | 
						|
 * \defgroup hal_gpioirq GPIO IRQ HAL functions
 | 
						|
 * @{
 | 
						|
 */
 | 
						|
 | 
						|
/** Initialize the GPIO IRQ pin
 | 
						|
 *
 | 
						|
 * @param obj     The GPIO object to initialize
 | 
						|
 * @param pin     The GPIO pin name
 | 
						|
 * @param handler The handler to be attached to GPIO IRQ
 | 
						|
 * @param id      The object ID (id != 0, 0 is reserved)
 | 
						|
 * @return -1 if pin is NC, 0 otherwise
 | 
						|
 */
 | 
						|
int gpio_irq_init(gpio_irq_t *obj, PinName pin, gpio_irq_handler handler, uint32_t id);
 | 
						|
 | 
						|
/** Release the GPIO IRQ PIN
 | 
						|
 *
 | 
						|
 * @param obj The gpio object
 | 
						|
 */
 | 
						|
void gpio_irq_free(gpio_irq_t *obj);
 | 
						|
 | 
						|
/** Enable/disable pin IRQ event
 | 
						|
 *
 | 
						|
 * @param obj    The GPIO object
 | 
						|
 * @param event  The GPIO IRQ event
 | 
						|
 * @param enable The enable flag
 | 
						|
 */
 | 
						|
void gpio_irq_set(gpio_irq_t *obj, gpio_irq_event event, uint32_t enable);
 | 
						|
 | 
						|
/** Enable GPIO IRQ
 | 
						|
 *
 | 
						|
 * This is target dependent, as it might enable the entire port or just a pin
 | 
						|
 * @param obj The GPIO object
 | 
						|
 */
 | 
						|
void gpio_irq_enable(gpio_irq_t *obj);
 | 
						|
 | 
						|
/** Disable GPIO IRQ
 | 
						|
 *
 | 
						|
 * This is target dependent, as it might disable the entire port or just a pin
 | 
						|
 * @param obj The GPIO object
 | 
						|
 */
 | 
						|
void gpio_irq_disable(gpio_irq_t *obj);
 | 
						|
 | 
						|
/**@}*/
 | 
						|
 | 
						|
#ifdef __cplusplus
 | 
						|
}
 | 
						|
#endif
 | 
						|
 | 
						|
#endif
 | 
						|
 | 
						|
#endif
 | 
						|
 | 
						|
/** @}*/
 |