Tomo Yamanaka / mbed-dev

mbed library sources. Supersedes mbed-src. GR-PEACH runs on RAM.

Fork of mbed-dev by mbed official

hal/gpio_api.h@103:493a29d2d4d7, 2016-03-30 (annotated)

Committer:
1050186
Date:
Wed Mar 30 11:41:25 2016 +0000
Revision:
103:493a29d2d4d7
Parent:
0:9b334a45a8ff 
GR-PEACH runs on RAM.

Who changed what in which revision?

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