Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

drivers/DigitalOut.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_DIGITALOUT_H
switches 0:5c4d7b2438d3 17 #define MBED_DIGITALOUT_H
switches 0:5c4d7b2438d3 18
switches 0:5c4d7b2438d3 19 #include "platform/platform.h"
switches 0:5c4d7b2438d3 20 #include "hal/gpio_api.h"
switches 0:5c4d7b2438d3 21 #include "platform/critical.h"
switches 0:5c4d7b2438d3 22
switches 0:5c4d7b2438d3 23 namespace mbed {
switches 0:5c4d7b2438d3 24 /** \addtogroup drivers */
switches 0:5c4d7b2438d3 25 /** @{*/
switches 0:5c4d7b2438d3 26
switches 0:5c4d7b2438d3 27 /** A digital output, used for setting the state of a pin
switches 0:5c4d7b2438d3 28 *
switches 0:5c4d7b2438d3 29 * @Note Synchronization level: Interrupt safe
switches 0:5c4d7b2438d3 30 *
switches 0:5c4d7b2438d3 31 * Example:
switches 0:5c4d7b2438d3 32 * @code
switches 0:5c4d7b2438d3 33 * // Toggle a LED
switches 0:5c4d7b2438d3 34 * #include "mbed.h"
switches 0:5c4d7b2438d3 35 *
switches 0:5c4d7b2438d3 36 * DigitalOut led(LED1);
switches 0:5c4d7b2438d3 37 *
switches 0:5c4d7b2438d3 38 * int main() {
switches 0:5c4d7b2438d3 39 * while(1) {
switches 0:5c4d7b2438d3 40 * led = !led;
switches 0:5c4d7b2438d3 41 * wait(0.2);
switches 0:5c4d7b2438d3 42 * }
switches 0:5c4d7b2438d3 43 * }
switches 0:5c4d7b2438d3 44 * @endcode
switches 0:5c4d7b2438d3 45 */
switches 0:5c4d7b2438d3 46 class DigitalOut {
switches 0:5c4d7b2438d3 47
switches 0:5c4d7b2438d3 48 public:
switches 0:5c4d7b2438d3 49 /** Create a DigitalOut connected to the specified pin
switches 0:5c4d7b2438d3 50 *
switches 0:5c4d7b2438d3 51 * @param pin DigitalOut pin to connect to
switches 0:5c4d7b2438d3 52 */
switches 0:5c4d7b2438d3 53 DigitalOut(PinName pin) : gpio() {
switches 0:5c4d7b2438d3 54 // No lock needed in the constructor
switches 0:5c4d7b2438d3 55 gpio_init_out(&gpio, pin);
switches 0:5c4d7b2438d3 56 }
switches 0:5c4d7b2438d3 57
switches 0:5c4d7b2438d3 58 /** Create a DigitalOut connected to the specified pin
switches 0:5c4d7b2438d3 59 *
switches 0:5c4d7b2438d3 60 * @param pin DigitalOut pin to connect to
switches 0:5c4d7b2438d3 61 * @param value the initial pin value
switches 0:5c4d7b2438d3 62 */
switches 0:5c4d7b2438d3 63 DigitalOut(PinName pin, int value) : gpio() {
switches 0:5c4d7b2438d3 64 // No lock needed in the constructor
switches 0:5c4d7b2438d3 65 gpio_init_out_ex(&gpio, pin, value);
switches 0:5c4d7b2438d3 66 }
switches 0:5c4d7b2438d3 67
switches 0:5c4d7b2438d3 68 /** Set the output, specified as 0 or 1 (int)
switches 0:5c4d7b2438d3 69 *
switches 0:5c4d7b2438d3 70 * @param value An integer specifying the pin output value,
switches 0:5c4d7b2438d3 71 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
switches 0:5c4d7b2438d3 72 */
switches 0:5c4d7b2438d3 73 void write(int value) {
switches 0:5c4d7b2438d3 74 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 75 gpio_write(&gpio, value);
switches 0:5c4d7b2438d3 76 }
switches 0:5c4d7b2438d3 77
switches 0:5c4d7b2438d3 78 /** Return the output setting, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 79 *
switches 0:5c4d7b2438d3 80 * @returns
switches 0:5c4d7b2438d3 81 * an integer representing the output setting of the pin,
switches 0:5c4d7b2438d3 82 * 0 for logical 0, 1 for logical 1
switches 0:5c4d7b2438d3 83 */
switches 0:5c4d7b2438d3 84 int read() {
switches 0:5c4d7b2438d3 85 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 86 return gpio_read(&gpio);
switches 0:5c4d7b2438d3 87 }
switches 0:5c4d7b2438d3 88
switches 0:5c4d7b2438d3 89 /** Return the output setting, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 90 *
switches 0:5c4d7b2438d3 91 * @returns
switches 0:5c4d7b2438d3 92 * Non zero value if pin is connected to uc GPIO
switches 0:5c4d7b2438d3 93 * 0 if gpio object was initialized with NC
switches 0:5c4d7b2438d3 94 */
switches 0:5c4d7b2438d3 95 int is_connected() {
switches 0:5c4d7b2438d3 96 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 97 return gpio_is_connected(&gpio);
switches 0:5c4d7b2438d3 98 }
switches 0:5c4d7b2438d3 99
switches 0:5c4d7b2438d3 100 /** A shorthand for write()
switches 0:5c4d7b2438d3 101 */
switches 0:5c4d7b2438d3 102 DigitalOut& operator= (int value) {
switches 0:5c4d7b2438d3 103 // Underlying write is thread safe
switches 0:5c4d7b2438d3 104 write(value);
switches 0:5c4d7b2438d3 105 return *this;
switches 0:5c4d7b2438d3 106 }
switches 0:5c4d7b2438d3 107
switches 0:5c4d7b2438d3 108 DigitalOut& operator= (DigitalOut& rhs) {
switches 0:5c4d7b2438d3 109 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 110 write(rhs.read());
switches 0:5c4d7b2438d3 111 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 112 return *this;
switches 0:5c4d7b2438d3 113 }
switches 0:5c4d7b2438d3 114
switches 0:5c4d7b2438d3 115 /** A shorthand for read()
switches 0:5c4d7b2438d3 116 */
switches 0:5c4d7b2438d3 117 operator int() {
switches 0:5c4d7b2438d3 118 // Underlying call is thread safe
switches 0:5c4d7b2438d3 119 return read();
switches 0:5c4d7b2438d3 120 }
switches 0:5c4d7b2438d3 121
switches 0:5c4d7b2438d3 122 protected:
switches 0:5c4d7b2438d3 123 gpio_t gpio;
switches 0:5c4d7b2438d3 124 };
switches 0:5c4d7b2438d3 125
switches 0:5c4d7b2438d3 126 } // namespace mbed
switches 0:5c4d7b2438d3 127
switches 0:5c4d7b2438d3 128 #endif
switches 0:5c4d7b2438d3 129
switches 0:5c4d7b2438d3 130 /** @}*/