gpio_object.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. /* mbed Microcontroller Library
  2. *******************************************************************************
  3. * Copyright (c) 2016, 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. #include "mbed_assert.h"
  33. #include "cmsis.h"
  34. #include "PortNames.h"
  35. #include "PeripheralNames.h"
  36. #include "PinNames.h"
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40. /*
  41. * Note: reg_clr might actually be same as reg_set.
  42. * Depends on family whether BRR is available on top of BSRR
  43. * if BRR does not exist, family shall define GPIO_IP_WITHOUT_BRR
  44. */
  45. typedef struct {
  46. uint32_t mask;
  47. __IO uint32_t *reg_in;
  48. __IO uint32_t *reg_set;
  49. __IO uint32_t *reg_clr;
  50. PinName pin;
  51. GPIO_TypeDef *gpio;
  52. uint32_t ll_pin;
  53. } gpio_t;
  54. static inline void gpio_write(gpio_t *obj, int value)
  55. {
  56. if (value) {
  57. *obj->reg_set = obj->mask;
  58. } else {
  59. #ifdef GPIO_IP_WITHOUT_BRR
  60. *obj->reg_clr = obj->mask << 16;
  61. #else
  62. *obj->reg_clr = obj->mask;
  63. #endif
  64. }
  65. }
  66. static inline int gpio_read(gpio_t *obj)
  67. {
  68. return ((*obj->reg_in & obj->mask) ? 1 : 0);
  69. }
  70. static inline int gpio_is_connected(const gpio_t *obj)
  71. {
  72. return obj->pin != (PinName)NC;
  73. }
  74. #ifdef __cplusplus
  75. }
  76. #endif
  77. #endif