Sukkin Pang / mbed-dev-bin

Initial release

Fork of mbed-dev-bin by Lancaster University

gpio_api.h@4:85cbef757caa, 2016-09-29 (annotated)

Committer:
pangsk
Date:
Thu Sep 29 15:33:10 2016 +0000
Revision:
4:85cbef757caa
Parent:
0:e1a608bb55e8 
Initial release

Who changed what in which revision?

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