PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/PortOut.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_PORTOUT_H
phungductung 0:aa3fc5ad02f7 17 #define MBED_PORTOUT_H
phungductung 0:aa3fc5ad02f7 18
phungductung 0:aa3fc5ad02f7 19 #include "platform.h"
phungductung 0:aa3fc5ad02f7 20
phungductung 0:aa3fc5ad02f7 21 #if DEVICE_PORTOUT
phungductung 0:aa3fc5ad02f7 22
phungductung 0:aa3fc5ad02f7 23 #include "port_api.h"
phungductung 0:aa3fc5ad02f7 24
phungductung 0:aa3fc5ad02f7 25 namespace mbed {
phungductung 0:aa3fc5ad02f7 26 /** A multiple pin digital out
phungductung 0:aa3fc5ad02f7 27 *
phungductung 0:aa3fc5ad02f7 28 * Example:
phungductung 0:aa3fc5ad02f7 29 * @code
phungductung 0:aa3fc5ad02f7 30 * // Toggle all four LEDs
phungductung 0:aa3fc5ad02f7 31 *
phungductung 0:aa3fc5ad02f7 32 * #include "mbed.h"
phungductung 0:aa3fc5ad02f7 33 *
phungductung 0:aa3fc5ad02f7 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
phungductung 0:aa3fc5ad02f7 35 * #define LED_MASK 0x00B40000
phungductung 0:aa3fc5ad02f7 36 *
phungductung 0:aa3fc5ad02f7 37 * PortOut ledport(Port1, LED_MASK);
phungductung 0:aa3fc5ad02f7 38 *
phungductung 0:aa3fc5ad02f7 39 * int main() {
phungductung 0:aa3fc5ad02f7 40 * while(1) {
phungductung 0:aa3fc5ad02f7 41 * ledport = LED_MASK;
phungductung 0:aa3fc5ad02f7 42 * wait(1);
phungductung 0:aa3fc5ad02f7 43 * ledport = 0;
phungductung 0:aa3fc5ad02f7 44 * wait(1);
phungductung 0:aa3fc5ad02f7 45 * }
phungductung 0:aa3fc5ad02f7 46 * }
phungductung 0:aa3fc5ad02f7 47 * @endcode
phungductung 0:aa3fc5ad02f7 48 */
phungductung 0:aa3fc5ad02f7 49 class PortOut {
phungductung 0:aa3fc5ad02f7 50 public:
phungductung 0:aa3fc5ad02f7 51
phungductung 0:aa3fc5ad02f7 52 /** Create an PortOut, connected to the specified port
phungductung 0:aa3fc5ad02f7 53 *
phungductung 0:aa3fc5ad02f7 54 * @param port Port to connect to (Port0-Port5)
phungductung 0:aa3fc5ad02f7 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
phungductung 0:aa3fc5ad02f7 56 */
phungductung 0:aa3fc5ad02f7 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
phungductung 0:aa3fc5ad02f7 58 port_init(&_port, port, mask, PIN_OUTPUT);
phungductung 0:aa3fc5ad02f7 59 }
phungductung 0:aa3fc5ad02f7 60
phungductung 0:aa3fc5ad02f7 61 /** Write the value to the output port
phungductung 0:aa3fc5ad02f7 62 *
phungductung 0:aa3fc5ad02f7 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
phungductung 0:aa3fc5ad02f7 64 */
phungductung 0:aa3fc5ad02f7 65 void write(int value) {
phungductung 0:aa3fc5ad02f7 66 port_write(&_port, value);
phungductung 0:aa3fc5ad02f7 67 }
phungductung 0:aa3fc5ad02f7 68
phungductung 0:aa3fc5ad02f7 69 /** Read the value currently output on the port
phungductung 0:aa3fc5ad02f7 70 *
phungductung 0:aa3fc5ad02f7 71 * @returns
phungductung 0:aa3fc5ad02f7 72 * An integer with each bit corresponding to associated PortOut pin setting
phungductung 0:aa3fc5ad02f7 73 */
phungductung 0:aa3fc5ad02f7 74 int read() {
phungductung 0:aa3fc5ad02f7 75 return port_read(&_port);
phungductung 0:aa3fc5ad02f7 76 }
phungductung 0:aa3fc5ad02f7 77
phungductung 0:aa3fc5ad02f7 78 /** A shorthand for write()
phungductung 0:aa3fc5ad02f7 79 */
phungductung 0:aa3fc5ad02f7 80 PortOut& operator= (int value) {
phungductung 0:aa3fc5ad02f7 81 write(value);
phungductung 0:aa3fc5ad02f7 82 return *this;
phungductung 0:aa3fc5ad02f7 83 }
phungductung 0:aa3fc5ad02f7 84
phungductung 0:aa3fc5ad02f7 85 PortOut& operator= (PortOut& rhs) {
phungductung 0:aa3fc5ad02f7 86 write(rhs.read());
phungductung 0:aa3fc5ad02f7 87 return *this;
phungductung 0:aa3fc5ad02f7 88 }
phungductung 0:aa3fc5ad02f7 89
phungductung 0:aa3fc5ad02f7 90 /** A shorthand for read()
phungductung 0:aa3fc5ad02f7 91 */
phungductung 0:aa3fc5ad02f7 92 operator int() {
phungductung 0:aa3fc5ad02f7 93 return read();
phungductung 0:aa3fc5ad02f7 94 }
phungductung 0:aa3fc5ad02f7 95
phungductung 0:aa3fc5ad02f7 96 private:
phungductung 0:aa3fc5ad02f7 97 port_t _port;
phungductung 0:aa3fc5ad02f7 98 };
phungductung 0:aa3fc5ad02f7 99
phungductung 0:aa3fc5ad02f7 100 } // namespace mbed
phungductung 0:aa3fc5ad02f7 101
phungductung 0:aa3fc5ad02f7 102 #endif
phungductung 0:aa3fc5ad02f7 103
phungductung 0:aa3fc5ad02f7 104 #endif