gpio_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_GPIO_API_H
00017 #define MBED_GPIO_API_H
00018 
00019 #include "device.h"
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00025 /* Set the given pin as GPIO
00026  * @param pin The pin to be set as GPIO
00027  * @return The GPIO port mask for this pin
00028  **/
00029 uint32_t gpio_set(PinName pin);
00030 
00031 /* Checks if gpio object is connected (pin was not initialized with NC)
00032  * @param pin The pin to be set as GPIO
00033  * @return 0 if port is initialized with NC
00034  **/
00035 int gpio_is_connected(const gpio_t *obj);
00036 
00037 /* GPIO object */
00038 void gpio_init(gpio_t *obj, PinName pin);
00039 
00040 void gpio_mode (gpio_t *obj, PinMode mode);
00041 void gpio_dir  (gpio_t *obj, PinDirection direction);
00042 
00043 void gpio_write(gpio_t *obj, int value);
00044 int  gpio_read (gpio_t *obj);
00045 
00046 // the following set of functions are generic and are implemented in the common gpio.c file
00047 void gpio_init_in(gpio_t* gpio, PinName pin);
00048 void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
00049 void gpio_init_out(gpio_t* gpio, PinName pin);
00050 void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
00051 void gpio_init_inout(gpio_t* gpio, PinName pin, PinDirection direction, PinMode mode, int value);
00052 
00053 #ifdef __cplusplus
00054 }
00055 #endif
00056 
00057 #endif