Jhon Plantikow / mbed

.

Dependents:   RTC

gpio_api.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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