tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_STM/TARGET_STM32F4/gpio_object.h

   1 /* mbed Microcontroller Library
   2  *******************************************************************************
   3  * Copyright (c) 2014, STMicroelectronics
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright notice,
  10  *    this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright notice,
  12  *    this list of conditions and the following disclaimer in the documentation
  13  *    and/or other materials provided with the distribution.
  14  * 3. Neither the name of STMicroelectronics nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *******************************************************************************
  29  */
  30 #ifndef MBED_GPIO_OBJECT_H
  31 #define MBED_GPIO_OBJECT_H
  32
  33 #include "mbed_assert.h"
  34 #include "cmsis.h"
  35 #include "PortNames.h"
  36 #include "PeripheralNames.h"
  37 #include "PinNames.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 typedef struct {
  44     PinName  pin;
  45     uint32_t mask;
  46     __IO uint32_t *reg_in;
  47     __IO uint16_t *reg_set;
  48     __IO uint16_t *reg_clr;
  49 } gpio_t;
  50
  51 static inline void gpio_write(gpio_t *obj, int value)
  52 {
  53     MBED_ASSERT(obj->pin != (PinName)NC);
  54     if (value) {
  55         *obj->reg_set = obj->mask;
  56     } else {
  57         *obj->reg_clr = obj->mask;
  58     }
  59 }
  60
  61 static inline int gpio_read(gpio_t *obj)
  62 {
  63     MBED_ASSERT(obj->pin != (PinName)NC);
  64     return ((*obj->reg_in & obj->mask) ? 1 : 0);
  65 }
  66
  67 static inline int gpio_is_connected(const gpio_t *obj) {
  68     return obj->pin != (PinName)NC;
  69 }
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif