David DiCarlo / mbed-src-KL05Z-smart-sensor

Fork of mbed for KL05Z based smart sensor which has no crystal on the board, so MCG FEI mode is required.

Dependents:   smart-sensor-KL05Z-debug

Fork of mbed-src by Ermanno Brusadin

api/DigitalIn.h@1:da408b460382, 2018-01-29 (annotated)

Committer:
r14793
Date:
Mon Jan 29 15:38:37 2018 +0000
Revision:
1:da408b460382
Parent:
0:0a673c671a56 
changed KL05 MCG mode to FEI for smart sensor boards (no crystal)

Who changed what in which revision?

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