Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/drivers/PortOut.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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