t
Fork of mbed-dev by
hal/gpio_api.h
- Committer:
- amithy
- Date:
- 2017-11-09
- Revision:
- 178:c26431f84b0d
- Parent:
- 149:156823d33999
- Child:
- 167:e84263d55307
File content as of revision 178:c26431f84b0d:
/** \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_API_H #define MBED_GPIO_API_H #include <stdint.h> #include "device.h" #ifdef __cplusplus extern "C" { #endif /** * \defgroup hal_gpio GPIO HAL functions * @{ */ /** Set the given pin as GPIO * * @param pin The pin to be set as GPIO * @return The GPIO port mask for this pin **/ uint32_t gpio_set(PinName pin); /* Checks if gpio object is connected (pin was not initialized with NC) * @param pin The pin to be set as GPIO * @return 0 if port is initialized with NC **/ int gpio_is_connected(const gpio_t *obj); /** Initialize the GPIO pin * * @param obj The GPIO object to initialize * @param pin The GPIO pin to initialize */ void gpio_init(gpio_t *obj, PinName pin); /** Set the input pin mode * * @param obj The GPIO object * @param mode The pin mode to be set */ void gpio_mode(gpio_t *obj, PinMode mode); /** Set the pin direction * * @param obj The GPIO object * @param direction The pin direction to be set */ void gpio_dir(gpio_t *obj, PinDirection direction); /** Set the output value * * @param obj The GPIO object * @param value The value to be set */ void gpio_write(gpio_t *obj, int value); /** Read the input value * * @param obj The GPIO object * @return An integer value 1 or 0 */ int gpio_read(gpio_t *obj); // the following functions are generic and implemented in the common gpio.c file // TODO: fix, will be moved to the common gpio header file /** Init the input pin and set mode to PullDefault * * @param obj The GPIO object * @param pin The pin name */ void gpio_init_in(gpio_t* gpio, PinName pin); /** Init the input pin and set the mode * * @param obj The GPIO object * @param pin The pin name * @param mode The pin mode to be set */ void gpio_init_in_ex(gpio_t* gpio, PinName pin, PinMode mode); /** Init the output pin as an output, with predefined output value 0 * * @param obj The GPIO object * @param pin The pin name * @return An integer value 1 or 0 */ void gpio_init_out(gpio_t* gpio, PinName pin); /** Init the pin as an output and set the output value * * @param obj The GPIO object * @param pin The pin name * @param value The value to be set */ void gpio_init_out_ex(gpio_t* gpio, PinName pin, int value); /** Init the pin to be in/out * * @param obj The GPIO object * @param pin The pin name * @param direction The pin direction to be set * @param mode The pin mode to be set * @param value The value to be set for an output pin */ void gpio_init_inout(gpio_t* gpio, PinName pin, PinDirection direction, PinMode mode, int value); /**@}*/ #ifdef __cplusplus } #endif #endif /** @}*/