Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/DigitalOut.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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