Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

drivers/DigitalIn.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_DIGITALIN_H
switches 0:5c4d7b2438d3 17 #define MBED_DIGITALIN_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, used for reading the state of a pin
switches 0:5c4d7b2438d3 29 *
switches 0:5c4d7b2438d3 30 * @Note Synchronization level: Interrupt safe
switches 0:5c4d7b2438d3 31 *
switches 0:5c4d7b2438d3 32 * Example:
switches 0:5c4d7b2438d3 33 * @code
switches 0:5c4d7b2438d3 34 * // Flash an LED while a DigitalIn is true
switches 0:5c4d7b2438d3 35 *
switches 0:5c4d7b2438d3 36 * #include "mbed.h"
switches 0:5c4d7b2438d3 37 *
switches 0:5c4d7b2438d3 38 * DigitalIn enable(p5);
switches 0:5c4d7b2438d3 39 * DigitalOut led(LED1);
switches 0:5c4d7b2438d3 40 *
switches 0:5c4d7b2438d3 41 * int main() {
switches 0:5c4d7b2438d3 42 * while(1) {
switches 0:5c4d7b2438d3 43 * if(enable) {
switches 0:5c4d7b2438d3 44 * led = !led;
switches 0:5c4d7b2438d3 45 * }
switches 0:5c4d7b2438d3 46 * wait(0.25);
switches 0:5c4d7b2438d3 47 * }
switches 0:5c4d7b2438d3 48 * }
switches 0:5c4d7b2438d3 49 * @endcode
switches 0:5c4d7b2438d3 50 */
switches 0:5c4d7b2438d3 51 class DigitalIn {
switches 0:5c4d7b2438d3 52
switches 0:5c4d7b2438d3 53 public:
switches 0:5c4d7b2438d3 54 /** Create a DigitalIn connected to the specified pin
switches 0:5c4d7b2438d3 55 *
switches 0:5c4d7b2438d3 56 * @param pin DigitalIn pin to connect to
switches 0:5c4d7b2438d3 57 */
switches 0:5c4d7b2438d3 58 DigitalIn(PinName pin) : gpio() {
switches 0:5c4d7b2438d3 59 // No lock needed in the constructor
switches 0:5c4d7b2438d3 60 gpio_init_in(&gpio, pin);
switches 0:5c4d7b2438d3 61 }
switches 0:5c4d7b2438d3 62
switches 0:5c4d7b2438d3 63 /** Create a DigitalIn connected to the specified pin
switches 0:5c4d7b2438d3 64 *
switches 0:5c4d7b2438d3 65 * @param pin DigitalIn pin to connect to
switches 0:5c4d7b2438d3 66 * @param mode the initial mode of the pin
switches 0:5c4d7b2438d3 67 */
switches 0:5c4d7b2438d3 68 DigitalIn(PinName pin, PinMode mode) : gpio() {
switches 0:5c4d7b2438d3 69 // No lock needed in the constructor
switches 0:5c4d7b2438d3 70 gpio_init_in_ex(&gpio, pin, mode);
switches 0:5c4d7b2438d3 71 }
switches 0:5c4d7b2438d3 72 /** Read the input, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 73 *
switches 0:5c4d7b2438d3 74 * @returns
switches 0:5c4d7b2438d3 75 * An integer representing the state of the input pin,
switches 0:5c4d7b2438d3 76 * 0 for logical 0, 1 for logical 1
switches 0:5c4d7b2438d3 77 */
switches 0:5c4d7b2438d3 78 int read() {
switches 0:5c4d7b2438d3 79 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 80 return gpio_read(&gpio);
switches 0:5c4d7b2438d3 81 }
switches 0:5c4d7b2438d3 82
switches 0:5c4d7b2438d3 83 /** Set the input pin mode
switches 0:5c4d7b2438d3 84 *
switches 0:5c4d7b2438d3 85 * @param mode PullUp, PullDown, PullNone, OpenDrain
switches 0:5c4d7b2438d3 86 */
switches 0:5c4d7b2438d3 87 void mode(PinMode pull) {
switches 0:5c4d7b2438d3 88 core_util_critical_section_enter();
switches 0:5c4d7b2438d3 89 gpio_mode(&gpio, pull);
switches 0:5c4d7b2438d3 90 core_util_critical_section_exit();
switches 0:5c4d7b2438d3 91 }
switches 0:5c4d7b2438d3 92
switches 0:5c4d7b2438d3 93 /** Return the output setting, represented as 0 or 1 (int)
switches 0:5c4d7b2438d3 94 *
switches 0:5c4d7b2438d3 95 * @returns
switches 0:5c4d7b2438d3 96 * Non zero value if pin is connected to uc GPIO
switches 0:5c4d7b2438d3 97 * 0 if gpio object was initialized with NC
switches 0:5c4d7b2438d3 98 */
switches 0:5c4d7b2438d3 99 int is_connected() {
switches 0:5c4d7b2438d3 100 // Thread safe / atomic HAL call
switches 0:5c4d7b2438d3 101 return gpio_is_connected(&gpio);
switches 0:5c4d7b2438d3 102 }
switches 0:5c4d7b2438d3 103
switches 0:5c4d7b2438d3 104 /** An operator shorthand for read()
switches 0:5c4d7b2438d3 105 */
switches 0:5c4d7b2438d3 106 operator int() {
switches 0:5c4d7b2438d3 107 // Underlying read is thread safe
switches 0:5c4d7b2438d3 108 return read();
switches 0:5c4d7b2438d3 109 }
switches 0:5c4d7b2438d3 110
switches 0:5c4d7b2438d3 111 protected:
switches 0:5c4d7b2438d3 112 gpio_t gpio;
switches 0:5c4d7b2438d3 113 };
switches 0:5c4d7b2438d3 114
switches 0:5c4d7b2438d3 115 } // namespace mbed
switches 0:5c4d7b2438d3 116
switches 0:5c4d7b2438d3 117 #endif
switches 0:5c4d7b2438d3 118
switches 0:5c4d7b2438d3 119 /** @}*/