Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/DigitalIn.h@1:d96dbedaebdb, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:54:50 2016 +0000
Revision:
1:d96dbedaebdb
Parent:
0:6c56fb4bc5f0 
Removed extra directories for other platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* mbed Microcontroller Library
nexpaq 0:6c56fb4bc5f0 2 * Copyright (c) 2006-2013 ARM Limited
nexpaq 0:6c56fb4bc5f0 3 *
nexpaq 0:6c56fb4bc5f0 4 * Licensed under the Apache License, Version 2.0 (the "License");
nexpaq 0:6c56fb4bc5f0 5 * you may not use this file except in compliance with the License.
nexpaq 0:6c56fb4bc5f0 6 * You may obtain a copy of the License at
nexpaq 0:6c56fb4bc5f0 7 *
nexpaq 0:6c56fb4bc5f0 8 * http://www.apache.org/licenses/LICENSE-2.0
nexpaq 0:6c56fb4bc5f0 9 *
nexpaq 0:6c56fb4bc5f0 10 * Unless required by applicable law or agreed to in writing, software
nexpaq 0:6c56fb4bc5f0 11 * distributed under the License is distributed on an "AS IS" BASIS,
nexpaq 0:6c56fb4bc5f0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nexpaq 0:6c56fb4bc5f0 13 * See the License for the specific language governing permissions and
nexpaq 0:6c56fb4bc5f0 14 * limitations under the License.
nexpaq 0:6c56fb4bc5f0 15 */
nexpaq 0:6c56fb4bc5f0 16 #ifndef MBED_DIGITALIN_H
nexpaq 0:6c56fb4bc5f0 17 #define MBED_DIGITALIN_H
nexpaq 0:6c56fb4bc5f0 18
nexpaq 0:6c56fb4bc5f0 19 #include "platform.h"
nexpaq 0:6c56fb4bc5f0 20
nexpaq 0:6c56fb4bc5f0 21 #include "gpio_api.h"
nexpaq 0:6c56fb4bc5f0 22 #include "critical.h"
nexpaq 0:6c56fb4bc5f0 23
nexpaq 0:6c56fb4bc5f0 24 namespace mbed {
nexpaq 0:6c56fb4bc5f0 25
nexpaq 0:6c56fb4bc5f0 26 /** A digital input, used for reading the state of a pin
nexpaq 0:6c56fb4bc5f0 27 *
nexpaq 0:6c56fb4bc5f0 28 * @Note Synchronization level: Interrupt safe
nexpaq 0:6c56fb4bc5f0 29 *
nexpaq 0:6c56fb4bc5f0 30 * Example:
nexpaq 0:6c56fb4bc5f0 31 * @code
nexpaq 0:6c56fb4bc5f0 32 * // Flash an LED while a DigitalIn is true
nexpaq 0:6c56fb4bc5f0 33 *
nexpaq 0:6c56fb4bc5f0 34 * #include "mbed.h"
nexpaq 0:6c56fb4bc5f0 35 *
nexpaq 0:6c56fb4bc5f0 36 * DigitalIn enable(p5);
nexpaq 0:6c56fb4bc5f0 37 * DigitalOut led(LED1);
nexpaq 0:6c56fb4bc5f0 38 *
nexpaq 0:6c56fb4bc5f0 39 * int main() {
nexpaq 0:6c56fb4bc5f0 40 * while(1) {
nexpaq 0:6c56fb4bc5f0 41 * if(enable) {
nexpaq 0:6c56fb4bc5f0 42 * led = !led;
nexpaq 0:6c56fb4bc5f0 43 * }
nexpaq 0:6c56fb4bc5f0 44 * wait(0.25);
nexpaq 0:6c56fb4bc5f0 45 * }
nexpaq 0:6c56fb4bc5f0 46 * }
nexpaq 0:6c56fb4bc5f0 47 * @endcode
nexpaq 0:6c56fb4bc5f0 48 */
nexpaq 0:6c56fb4bc5f0 49 class DigitalIn {
nexpaq 0:6c56fb4bc5f0 50
nexpaq 0:6c56fb4bc5f0 51 public:
nexpaq 0:6c56fb4bc5f0 52 /** Create a DigitalIn connected to the specified pin
nexpaq 0:6c56fb4bc5f0 53 *
nexpaq 0:6c56fb4bc5f0 54 * @param pin DigitalIn pin to connect to
nexpaq 0:6c56fb4bc5f0 55 */
nexpaq 0:6c56fb4bc5f0 56 DigitalIn(PinName pin) : gpio() {
nexpaq 0:6c56fb4bc5f0 57 // No lock needed in the constructor
nexpaq 0:6c56fb4bc5f0 58 gpio_init_in(&gpio, pin);
nexpaq 0:6c56fb4bc5f0 59 }
nexpaq 0:6c56fb4bc5f0 60
nexpaq 0:6c56fb4bc5f0 61 /** Create a DigitalIn connected to the specified pin
nexpaq 0:6c56fb4bc5f0 62 *
nexpaq 0:6c56fb4bc5f0 63 * @param pin DigitalIn pin to connect to
nexpaq 0:6c56fb4bc5f0 64 * @param mode the initial mode of the pin
nexpaq 0:6c56fb4bc5f0 65 */
nexpaq 0:6c56fb4bc5f0 66 DigitalIn(PinName pin, PinMode mode) : gpio() {
nexpaq 0:6c56fb4bc5f0 67 // No lock needed in the constructor
nexpaq 0:6c56fb4bc5f0 68 gpio_init_in_ex(&gpio, pin, mode);
nexpaq 0:6c56fb4bc5f0 69 }
nexpaq 0:6c56fb4bc5f0 70 /** Read the input, represented as 0 or 1 (int)
nexpaq 0:6c56fb4bc5f0 71 *
nexpaq 0:6c56fb4bc5f0 72 * @returns
nexpaq 0:6c56fb4bc5f0 73 * An integer representing the state of the input pin,
nexpaq 0:6c56fb4bc5f0 74 * 0 for logical 0, 1 for logical 1
nexpaq 0:6c56fb4bc5f0 75 */
nexpaq 0:6c56fb4bc5f0 76 int read() {
nexpaq 0:6c56fb4bc5f0 77 // Thread safe / atomic HAL call
nexpaq 0:6c56fb4bc5f0 78 return gpio_read(&gpio);
nexpaq 0:6c56fb4bc5f0 79 }
nexpaq 0:6c56fb4bc5f0 80
nexpaq 0:6c56fb4bc5f0 81 /** Set the input pin mode
nexpaq 0:6c56fb4bc5f0 82 *
nexpaq 0:6c56fb4bc5f0 83 * @param mode PullUp, PullDown, PullNone, OpenDrain
nexpaq 0:6c56fb4bc5f0 84 */
nexpaq 0:6c56fb4bc5f0 85 void mode(PinMode pull) {
nexpaq 0:6c56fb4bc5f0 86 core_util_critical_section_enter();
nexpaq 0:6c56fb4bc5f0 87 gpio_mode(&gpio, pull);
nexpaq 0:6c56fb4bc5f0 88 core_util_critical_section_exit();
nexpaq 0:6c56fb4bc5f0 89 }
nexpaq 0:6c56fb4bc5f0 90
nexpaq 0:6c56fb4bc5f0 91 /** Return the output setting, represented as 0 or 1 (int)
nexpaq 0:6c56fb4bc5f0 92 *
nexpaq 0:6c56fb4bc5f0 93 * @returns
nexpaq 0:6c56fb4bc5f0 94 * Non zero value if pin is connected to uc GPIO
nexpaq 0:6c56fb4bc5f0 95 * 0 if gpio object was initialized with NC
nexpaq 0:6c56fb4bc5f0 96 */
nexpaq 0:6c56fb4bc5f0 97 int is_connected() {
nexpaq 0:6c56fb4bc5f0 98 // Thread safe / atomic HAL call
nexpaq 0:6c56fb4bc5f0 99 return gpio_is_connected(&gpio);
nexpaq 0:6c56fb4bc5f0 100 }
nexpaq 0:6c56fb4bc5f0 101
nexpaq 0:6c56fb4bc5f0 102 /** An operator shorthand for read()
nexpaq 0:6c56fb4bc5f0 103 */
nexpaq 0:6c56fb4bc5f0 104 operator int() {
nexpaq 0:6c56fb4bc5f0 105 // Underlying read is thread safe
nexpaq 0:6c56fb4bc5f0 106 return read();
nexpaq 0:6c56fb4bc5f0 107 }
nexpaq 0:6c56fb4bc5f0 108
nexpaq 0:6c56fb4bc5f0 109 protected:
nexpaq 0:6c56fb4bc5f0 110 gpio_t gpio;
nexpaq 0:6c56fb4bc5f0 111 };
nexpaq 0:6c56fb4bc5f0 112
nexpaq 0:6c56fb4bc5f0 113 } // namespace mbed
nexpaq 0:6c56fb4bc5f0 114
nexpaq 0:6c56fb4bc5f0 115 #endif