Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/PortOut.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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