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/DigitalOut.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_DIGITALOUT_H
ebrus 0:0a673c671a56 17 #define MBED_DIGITALOUT_H
ebrus 0:0a673c671a56 18
ebrus 0:0a673c671a56 19 #include "platform.h"
ebrus 0:0a673c671a56 20 #include "gpio_api.h"
ebrus 0:0a673c671a56 21
ebrus 0:0a673c671a56 22 namespace mbed {
ebrus 0:0a673c671a56 23
ebrus 0:0a673c671a56 24 /** A digital output, used for setting the state of a pin
ebrus 0:0a673c671a56 25 *
ebrus 0:0a673c671a56 26 * Example:
ebrus 0:0a673c671a56 27 * @code
ebrus 0:0a673c671a56 28 * // Toggle a LED
ebrus 0:0a673c671a56 29 * #include "mbed.h"
ebrus 0:0a673c671a56 30 *
ebrus 0:0a673c671a56 31 * DigitalOut led(LED1);
ebrus 0:0a673c671a56 32 *
ebrus 0:0a673c671a56 33 * int main() {
ebrus 0:0a673c671a56 34 * while(1) {
ebrus 0:0a673c671a56 35 * led = !led;
ebrus 0:0a673c671a56 36 * wait(0.2);
ebrus 0:0a673c671a56 37 * }
ebrus 0:0a673c671a56 38 * }
ebrus 0:0a673c671a56 39 * @endcode
ebrus 0:0a673c671a56 40 */
ebrus 0:0a673c671a56 41 class DigitalOut {
ebrus 0:0a673c671a56 42
ebrus 0:0a673c671a56 43 public:
ebrus 0:0a673c671a56 44 /** Create a DigitalOut connected to the specified pin
ebrus 0:0a673c671a56 45 *
ebrus 0:0a673c671a56 46 * @param pin DigitalOut pin to connect to
ebrus 0:0a673c671a56 47 */
ebrus 0:0a673c671a56 48 DigitalOut(PinName pin) : gpio() {
ebrus 0:0a673c671a56 49 gpio_init_out(&gpio, pin);
ebrus 0:0a673c671a56 50 }
ebrus 0:0a673c671a56 51
ebrus 0:0a673c671a56 52 /** Create a DigitalOut connected to the specified pin
ebrus 0:0a673c671a56 53 *
ebrus 0:0a673c671a56 54 * @param pin DigitalOut pin to connect to
ebrus 0:0a673c671a56 55 * @param value the initial pin value
ebrus 0:0a673c671a56 56 */
ebrus 0:0a673c671a56 57 DigitalOut(PinName pin, int value) : gpio() {
ebrus 0:0a673c671a56 58 gpio_init_out_ex(&gpio, pin, value);
ebrus 0:0a673c671a56 59 }
ebrus 0:0a673c671a56 60
ebrus 0:0a673c671a56 61 /** Set the output, specified as 0 or 1 (int)
ebrus 0:0a673c671a56 62 *
ebrus 0:0a673c671a56 63 * @param value An integer specifying the pin output value,
ebrus 0:0a673c671a56 64 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
ebrus 0:0a673c671a56 65 */
ebrus 0:0a673c671a56 66 void write(int value) {
ebrus 0:0a673c671a56 67 gpio_write(&gpio, value);
ebrus 0:0a673c671a56 68 }
ebrus 0:0a673c671a56 69
ebrus 0:0a673c671a56 70 /** Return the output setting, represented as 0 or 1 (int)
ebrus 0:0a673c671a56 71 *
ebrus 0:0a673c671a56 72 * @returns
ebrus 0:0a673c671a56 73 * an integer representing the output setting of the pin,
ebrus 0:0a673c671a56 74 * 0 for logical 0, 1 for logical 1
ebrus 0:0a673c671a56 75 */
ebrus 0:0a673c671a56 76 int read() {
ebrus 0:0a673c671a56 77 return gpio_read(&gpio);
ebrus 0:0a673c671a56 78 }
ebrus 0:0a673c671a56 79
ebrus 0:0a673c671a56 80 #ifdef MBED_OPERATORS
ebrus 0:0a673c671a56 81 /** A shorthand for write()
ebrus 0:0a673c671a56 82 */
ebrus 0:0a673c671a56 83 DigitalOut& operator= (int value) {
ebrus 0:0a673c671a56 84 write(value);
ebrus 0:0a673c671a56 85 return *this;
ebrus 0:0a673c671a56 86 }
ebrus 0:0a673c671a56 87
ebrus 0:0a673c671a56 88 DigitalOut& operator= (DigitalOut& rhs) {
ebrus 0:0a673c671a56 89 write(rhs.read());
ebrus 0:0a673c671a56 90 return *this;
ebrus 0:0a673c671a56 91 }
ebrus 0:0a673c671a56 92
ebrus 0:0a673c671a56 93 /** A shorthand for read()
ebrus 0:0a673c671a56 94 */
ebrus 0:0a673c671a56 95 operator int() {
ebrus 0:0a673c671a56 96 return read();
ebrus 0:0a673c671a56 97 }
ebrus 0:0a673c671a56 98 #endif
ebrus 0:0a673c671a56 99
ebrus 0:0a673c671a56 100 protected:
ebrus 0:0a673c671a56 101 gpio_t gpio;
ebrus 0:0a673c671a56 102 };
ebrus 0:0a673c671a56 103
ebrus 0:0a673c671a56 104 } // namespace mbed
ebrus 0:0a673c671a56 105
ebrus 0:0a673c671a56 106 #endif