Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/drivers/PortOut.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Zaitsev 10:41552d038a69 1 /* mbed Microcontroller Library
Zaitsev 10:41552d038a69 2 * Copyright (c) 2006-2013 ARM Limited
Zaitsev 10:41552d038a69 3 *
Zaitsev 10:41552d038a69 4 * Licensed under the Apache License, Version 2.0 (the "License");
Zaitsev 10:41552d038a69 5 * you may not use this file except in compliance with the License.
Zaitsev 10:41552d038a69 6 * You may obtain a copy of the License at
Zaitsev 10:41552d038a69 7 *
Zaitsev 10:41552d038a69 8 * http://www.apache.org/licenses/LICENSE-2.0
Zaitsev 10:41552d038a69 9 *
Zaitsev 10:41552d038a69 10 * Unless required by applicable law or agreed to in writing, software
Zaitsev 10:41552d038a69 11 * distributed under the License is distributed on an "AS IS" BASIS,
Zaitsev 10:41552d038a69 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Zaitsev 10:41552d038a69 13 * See the License for the specific language governing permissions and
Zaitsev 10:41552d038a69 14 * limitations under the License.
Zaitsev 10:41552d038a69 15 */
Zaitsev 10:41552d038a69 16 #ifndef MBED_PORTOUT_H
Zaitsev 10:41552d038a69 17 #define MBED_PORTOUT_H
Zaitsev 10:41552d038a69 18
Zaitsev 10:41552d038a69 19 #include "platform/platform.h"
Zaitsev 10:41552d038a69 20
Zaitsev 10:41552d038a69 21 #if DEVICE_PORTOUT
Zaitsev 10:41552d038a69 22
Zaitsev 10:41552d038a69 23 #include "hal/port_api.h"
Zaitsev 10:41552d038a69 24 #include "platform/critical.h"
Zaitsev 10:41552d038a69 25
Zaitsev 10:41552d038a69 26 namespace mbed {
Zaitsev 10:41552d038a69 27 /** \addtogroup drivers */
Zaitsev 10:41552d038a69 28 /** @{*/
Zaitsev 10:41552d038a69 29 /** A multiple pin digital out
Zaitsev 10:41552d038a69 30 *
Zaitsev 10:41552d038a69 31 * @Note Synchronization level: Interrupt safe
Zaitsev 10:41552d038a69 32 *
Zaitsev 10:41552d038a69 33 * Example:
Zaitsev 10:41552d038a69 34 * @code
Zaitsev 10:41552d038a69 35 * // Toggle all four LEDs
Zaitsev 10:41552d038a69 36 *
Zaitsev 10:41552d038a69 37 * #include "mbed.h"
Zaitsev 10:41552d038a69 38 *
Zaitsev 10:41552d038a69 39 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
Zaitsev 10:41552d038a69 40 * #define LED_MASK 0x00B40000
Zaitsev 10:41552d038a69 41 *
Zaitsev 10:41552d038a69 42 * PortOut ledport(Port1, LED_MASK);
Zaitsev 10:41552d038a69 43 *
Zaitsev 10:41552d038a69 44 * int main() {
Zaitsev 10:41552d038a69 45 * while(1) {
Zaitsev 10:41552d038a69 46 * ledport = LED_MASK;
Zaitsev 10:41552d038a69 47 * wait(1);
Zaitsev 10:41552d038a69 48 * ledport = 0;
Zaitsev 10:41552d038a69 49 * wait(1);
Zaitsev 10:41552d038a69 50 * }
Zaitsev 10:41552d038a69 51 * }
Zaitsev 10:41552d038a69 52 * @endcode
Zaitsev 10:41552d038a69 53 */
Zaitsev 10:41552d038a69 54 class PortOut {
Zaitsev 10:41552d038a69 55 public:
Zaitsev 10:41552d038a69 56
Zaitsev 10:41552d038a69 57 /** Create an PortOut, connected to the specified port
Zaitsev 10:41552d038a69 58 *
Zaitsev 10:41552d038a69 59 * @param port Port to connect to (Port0-Port5)
Zaitsev 10:41552d038a69 60 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
Zaitsev 10:41552d038a69 61 */
Zaitsev 10:41552d038a69 62 PortOut(PortName port, int mask = 0xFFFFFFFF) {
Zaitsev 10:41552d038a69 63 core_util_critical_section_enter();
Zaitsev 10:41552d038a69 64 port_init(&_port, port, mask, PIN_OUTPUT);
Zaitsev 10:41552d038a69 65 core_util_critical_section_exit();
Zaitsev 10:41552d038a69 66 }
Zaitsev 10:41552d038a69 67
Zaitsev 10:41552d038a69 68 /** Write the value to the output port
Zaitsev 10:41552d038a69 69 *
Zaitsev 10:41552d038a69 70 * @param value An integer specifying a bit to write for every corresponding PortOut pin
Zaitsev 10:41552d038a69 71 */
Zaitsev 10:41552d038a69 72 void write(int value) {
Zaitsev 10:41552d038a69 73 port_write(&_port, value);
Zaitsev 10:41552d038a69 74 }
Zaitsev 10:41552d038a69 75
Zaitsev 10:41552d038a69 76 /** Read the value currently output on the port
Zaitsev 10:41552d038a69 77 *
Zaitsev 10:41552d038a69 78 * @returns
Zaitsev 10:41552d038a69 79 * An integer with each bit corresponding to associated PortOut pin setting
Zaitsev 10:41552d038a69 80 */
Zaitsev 10:41552d038a69 81 int read() {
Zaitsev 10:41552d038a69 82 return port_read(&_port);
Zaitsev 10:41552d038a69 83 }
Zaitsev 10:41552d038a69 84
Zaitsev 10:41552d038a69 85 /** A shorthand for write()
Zaitsev 10:41552d038a69 86 */
Zaitsev 10:41552d038a69 87 PortOut& operator= (int value) {
Zaitsev 10:41552d038a69 88 write(value);
Zaitsev 10:41552d038a69 89 return *this;
Zaitsev 10:41552d038a69 90 }
Zaitsev 10:41552d038a69 91
Zaitsev 10:41552d038a69 92 PortOut& operator= (PortOut& rhs) {
Zaitsev 10:41552d038a69 93 write(rhs.read());
Zaitsev 10:41552d038a69 94 return *this;
Zaitsev 10:41552d038a69 95 }
Zaitsev 10:41552d038a69 96
Zaitsev 10:41552d038a69 97 /** A shorthand for read()
Zaitsev 10:41552d038a69 98 */
Zaitsev 10:41552d038a69 99 operator int() {
Zaitsev 10:41552d038a69 100 return read();
Zaitsev 10:41552d038a69 101 }
Zaitsev 10:41552d038a69 102
Zaitsev 10:41552d038a69 103 private:
Zaitsev 10:41552d038a69 104 port_t _port;
Zaitsev 10:41552d038a69 105 };
Zaitsev 10:41552d038a69 106
Zaitsev 10:41552d038a69 107 } // namespace mbed
Zaitsev 10:41552d038a69 108
Zaitsev 10:41552d038a69 109 #endif
Zaitsev 10:41552d038a69 110
Zaitsev 10:41552d038a69 111 #endif
Zaitsev 10:41552d038a69 112
Zaitsev 10:41552d038a69 113 /** @}*/