1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2013 ARM Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 #ifndef MBED_GPIO_API_H
17 #define MBED_GPIO_API_H
25 /* Set the given pin as GPIO
26 * @param pin The pin to be set as GPIO
27 * @return The GPIO port mask for this pin
29 uint32_t gpio_set(PinName pin);
31 /* Checks if gpio object is connected (pin was not initialized with NC)
32 * @param pin The pin to be set as GPIO
33 * @return 0 if port is initialized with NC
35 int gpio_is_connected(const gpio_t *obj);
38 void gpio_init(gpio_t *obj, PinName pin);
40 void gpio_mode (gpio_t *obj, PinMode mode);
41 void gpio_dir (gpio_t *obj, PinDirection direction);
43 void gpio_write(gpio_t *obj, int value);
44 int gpio_read (gpio_t *obj);
46 // the following set of functions are generic and are implemented in the common gpio.c file
47 void gpio_init_in(gpio_t* gpio, PinName pin);
48 void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode);
49 void gpio_init_out(gpio_t* gpio, PinName pin);
50 void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value);
51 void gpio_init_inout(gpio_t* gpio, PinName pin, PinDirection direction, PinMode mode, int value);