Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

drivers/DigitalInOut.h@3:1198227e6421, 2016-12-16 (annotated)

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3 
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
switches 0:5c4d7b2438d3 1 /* mbed Microcontroller Library
switches 0:5c4d7b2438d3 2 * Copyright (c) 2006-2013 ARM Limited
switches 0:5c4d7b2438d3 3 *
switches 0:5c4d7b2438d3 4 * Licensed under the Apache License, Version 2.0 (the "License");
switches 0:5c4d7b2438d3 5 * you may not use this file except in compliance with the License.
switches 0:5c4d7b2438d3 6 * You may obtain a copy of the License at
switches 0:5c4d7b2438d3 7 *
switches 0:5c4d7b2438d3 8 * http://www.apache.org/licenses/LICENSE-2.0
switches 0:5c4d7b2438d3 9 *
switches 0:5c4d7b2438d3 10 * Unless required by applicable law or agreed to in writing, software
switches 0:5c4d7b2438d3 11 * distributed under the License is distributed on an "AS IS" BASIS,
switches 0:5c4d7b2438d3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
switches 0:5c4d7b2438d3 13 * See the License for the specific language governing permissions and
switches 0:5c4d7b2438d3 14 * limitations under the License.
switches 0:5c4d7b2438d3 15 */
switches 0:5c4d7b2438d3 16 #ifndef MBED_DIGITALINOUT_H
switches 0:5c4d7b2438d3 17 #define MBED_DIGITALINOUT_H
switches 0:5c4d7b2438d3 18
switches 0:5c4d7b2438d3 19 #include "platform/platform.h"
switches 0:5c4d7b2438d3 20
switches 0:5c4d7b2438d3 21 #include "hal/gpio_api.h"
switches 0:5c4d7b2438d3 22 #include "platform/critical.h"
switches 0:5c4d7b2438d3 23
switches 0:5c4d7b2438d3 24 namespace mbed {
switches 0:5c4d7b2438d3 25 /** \addtogroup drivers */
switches 0:5c4d7b2438d3 26 /** @{*/
switches 0:5c4d7b2438d3 27
switches 0:5c4d7b2438d3 28 /** A digital input/output, used for setting or reading a bi-directional pin
switches 0:5c4d7b2438d3 29 *
switches 0:5c4d7b2438d3 30 * @Note Synchronization level: Interrupt safe
switches 0:5c4d7b2438d3 31 */
switches 0:5c4d7b2438d3 32 class DigitalInOut {
switches 0:5c4d7b2438d3 33
switches 0:5c4d7b2438d3 34 public:
switches 0:5c4d7b2438d3 35 /** Create a DigitalInOut connected to the specified pin
switches 0:5c4d7b2438d3 36 *
switches 0:5c4d7b2438d3 37 * @param pin DigitalInOut pin to connect to
switches 0:5c4d7b2438d3 38 */
switches 0:5c4d7b2438d3 39 DigitalInOut(PinName pin) : gpio() {
switches 0:5c4d7b2438d3 40 // No lock needed in the constructor
switches 0:5c4d7b2438d3 41 gpio_init_in(&gpio, pin);
switches 0:5c4d7b2438d3 42 }
switches 0:5c4d7b2438d3 43
switches 0:5c4d7b2438d3 44 /** Create a DigitalInOut connected to the specified pin
switches 0:5c4d7b2438d3 45 *
switches 0:5c4d7b2438d3 46 * @param pin DigitalInOut pin to connect to
switches 0:5c4d7b2438d3 47 * @param direction the initial direction of the pin
switches 0:5c4d7b2438d3 48 * @param mode the initial mode of the pin
switches 0:5c4d7b2438d3 49 * @param value the initial value of the pin if is an output
switches 0:5c4d7b2438d3 50 */
switches 0:5c4d7b2438d3 51 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio() {
switches 0:5c4d7b2438d3 52 // No lock needed in the constructor
switches 0:5c4d7b2438d3 53 gpio_init_inout(&gpio, pin, direction, mode, value);
switches 0:5c4d7b2438d3 54 }
switches 0:5c4d7b2438d3 55
switches 0:5c4d7b2438d3 56 /** Set the output, specified as 0 or 1 (int)
switches 0:5c4d7b2438d3 57 *
switches 0:5c4d7b2438d3 58 * @param value An integer specifying the pin output value,
switches 0:5c4d7b2438d3 59 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
switches 0:5c4d7b2438d3 60 */
switches 0:5c4d7b2438d3 61 void write(int value) {
switches 0:5c4d7b2438d3 62 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 63 gpio_write(&gpio, value);
switches 0:5c4d7b2438d3 64 }
switches 0:5c4d7b2438d3 65
switches 0:5c4d7b2438d3 66 /** Return the output setting, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 67 *
switches 0:5c4d7b2438d3 68 * @returns
switches 0:5c4d7b2438d3 69 * an integer representing the output setting of the pin if it is an output,
switches 0:5c4d7b2438d3 70 * or read the input if set as an input
switches 0:5c4d7b2438d3 71 */
switches 0:5c4d7b2438d3 72 int read() {
switches 0:5c4d7b2438d3 73 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 74 return gpio_read(&gpio);
switches 0:5c4d7b2438d3 75 }
switches 0:5c4d7b2438d3 76
switches 0:5c4d7b2438d3 77 /** Set as an output
switches 0:5c4d7b2438d3 78 */
switches 0:5c4d7b2438d3 79 void output() {
switches 0:5c4d7b2438d3 80 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 81 gpio_dir(&gpio, PIN_OUTPUT);
switches 0:5c4d7b2438d3 82 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 83 }
switches 0:5c4d7b2438d3 84
switches 0:5c4d7b2438d3 85 /** Set as an input
switches 0:5c4d7b2438d3 86 */
switches 0:5c4d7b2438d3 87 void input() {
switches 0:5c4d7b2438d3 88 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 89 gpio_dir(&gpio, PIN_INPUT);
switches 0:5c4d7b2438d3 90 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 91 }
switches 0:5c4d7b2438d3 92
switches 0:5c4d7b2438d3 93 /** Set the input pin mode
switches 0:5c4d7b2438d3 94 *
switches 0:5c4d7b2438d3 95 * @param mode PullUp, PullDown, PullNone, OpenDrain
switches 0:5c4d7b2438d3 96 */
switches 0:5c4d7b2438d3 97 void mode(PinMode pull) {
switches 0:5c4d7b2438d3 98 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 99 gpio_mode(&gpio, pull);
switches 0:5c4d7b2438d3 100 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 101 }
switches 0:5c4d7b2438d3 102
switches 0:5c4d7b2438d3 103 /** Return the output setting, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 104 *
switches 0:5c4d7b2438d3 105 * @returns
switches 0:5c4d7b2438d3 106 * Non zero value if pin is connected to uc GPIO
switches 0:5c4d7b2438d3 107 * 0 if gpio object was initialized with NC
switches 0:5c4d7b2438d3 108 */
switches 0:5c4d7b2438d3 109 int is_connected() {
switches 0:5c4d7b2438d3 110 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 111 return gpio_is_connected(&gpio);
switches 0:5c4d7b2438d3 112 }
switches 0:5c4d7b2438d3 113
switches 0:5c4d7b2438d3 114 /** A shorthand for write()
switches 0:5c4d7b2438d3 115 */
switches 0:5c4d7b2438d3 116 DigitalInOut& operator= (int value) {
switches 0:5c4d7b2438d3 117 // Underlying write is thread safe
switches 0:5c4d7b2438d3 118 write(value);
switches 0:5c4d7b2438d3 119 return *this;
switches 0:5c4d7b2438d3 120 }
switches 0:5c4d7b2438d3 121
switches 0:5c4d7b2438d3 122 DigitalInOut& operator= (DigitalInOut& rhs) {
switches 0:5c4d7b2438d3 123 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 124 write(rhs.read());
switches 0:5c4d7b2438d3 125 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 126 return *this;
switches 0:5c4d7b2438d3 127 }
switches 0:5c4d7b2438d3 128
switches 0:5c4d7b2438d3 129 /** A shorthand for read()
switches 0:5c4d7b2438d3 130 */
switches 0:5c4d7b2438d3 131 operator int() {
switches 0:5c4d7b2438d3 132 // Underlying call is thread safe
switches 0:5c4d7b2438d3 133 return read();
switches 0:5c4d7b2438d3 134 }
switches 0:5c4d7b2438d3 135
switches 0:5c4d7b2438d3 136 protected:
switches 0:5c4d7b2438d3 137 gpio_t gpio;
switches 0:5c4d7b2438d3 138 };
switches 0:5c4d7b2438d3 139
switches 0:5c4d7b2438d3 140 } // namespace mbed
switches 0:5c4d7b2438d3 141
switches 0:5c4d7b2438d3 142 #endif
switches 0:5c4d7b2438d3 143
switches 0:5c4d7b2438d3 144 /** @}*/