PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/DigitalOut.h@0:aa3fc5ad02f7, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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