Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/PortInOut.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_PORTINOUT_H
valeyev 0:e056ac8fecf8 17 #define MBED_PORTINOUT_H
valeyev 0:e056ac8fecf8 18
valeyev 0:e056ac8fecf8 19 #include "platform/platform.h"
valeyev 0:e056ac8fecf8 20
valeyev 0:e056ac8fecf8 21 #if defined (DEVICE_PORTINOUT) || 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
valeyev 0:e056ac8fecf8 29 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
valeyev 0:e056ac8fecf8 30 *
valeyev 0:e056ac8fecf8 31 * @note Synchronization level: Interrupt safe
valeyev 0:e056ac8fecf8 32 * @ingroup drivers
valeyev 0:e056ac8fecf8 33 */
valeyev 0:e056ac8fecf8 34 class PortInOut {
valeyev 0:e056ac8fecf8 35 public:
valeyev 0:e056ac8fecf8 36
valeyev 0:e056ac8fecf8 37 /** Create an PortInOut, connected to the specified port
valeyev 0:e056ac8fecf8 38 *
valeyev 0:e056ac8fecf8 39 * @param port Port to connect to (Port0-Port5)
valeyev 0:e056ac8fecf8 40 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
valeyev 0:e056ac8fecf8 41 */
valeyev 0:e056ac8fecf8 42 PortInOut(PortName port, int mask = 0xFFFFFFFF) {
valeyev 0:e056ac8fecf8 43 core_util_critical_section_enter();
valeyev 0:e056ac8fecf8 44 port_init(&_port, port, mask, PIN_INPUT);
valeyev 0:e056ac8fecf8 45 core_util_critical_section_exit();
valeyev 0:e056ac8fecf8 46 }
valeyev 0:e056ac8fecf8 47
valeyev 0:e056ac8fecf8 48 /** Write the value to the output port
valeyev 0:e056ac8fecf8 49 *
valeyev 0:e056ac8fecf8 50 * @param value An integer specifying a bit to write for every corresponding port pin
valeyev 0:e056ac8fecf8 51 */
valeyev 0:e056ac8fecf8 52 void write(int value) {
valeyev 0:e056ac8fecf8 53 port_write(&_port, value);
valeyev 0:e056ac8fecf8 54 }
valeyev 0:e056ac8fecf8 55
valeyev 0:e056ac8fecf8 56 /** Read the value currently output on the port
valeyev 0:e056ac8fecf8 57 *
valeyev 0:e056ac8fecf8 58 * @returns
valeyev 0:e056ac8fecf8 59 * An integer with each bit corresponding to associated port pin setting
valeyev 0:e056ac8fecf8 60 */
valeyev 0:e056ac8fecf8 61 int read() {
valeyev 0:e056ac8fecf8 62 return port_read(&_port);
valeyev 0:e056ac8fecf8 63 }
valeyev 0:e056ac8fecf8 64
valeyev 0:e056ac8fecf8 65 /** Set as an output
valeyev 0:e056ac8fecf8 66 */
valeyev 0:e056ac8fecf8 67 void output() {
valeyev 0:e056ac8fecf8 68 core_util_critical_section_enter();
valeyev 0:e056ac8fecf8 69 port_dir(&_port, PIN_OUTPUT);
valeyev 0:e056ac8fecf8 70 core_util_critical_section_exit();
valeyev 0:e056ac8fecf8 71 }
valeyev 0:e056ac8fecf8 72
valeyev 0:e056ac8fecf8 73 /** Set as an input
valeyev 0:e056ac8fecf8 74 */
valeyev 0:e056ac8fecf8 75 void input() {
valeyev 0:e056ac8fecf8 76 core_util_critical_section_enter();
valeyev 0:e056ac8fecf8 77 port_dir(&_port, PIN_INPUT);
valeyev 0:e056ac8fecf8 78 core_util_critical_section_exit();
valeyev 0:e056ac8fecf8 79 }
valeyev 0:e056ac8fecf8 80
valeyev 0:e056ac8fecf8 81 /** Set the input pin mode
valeyev 0:e056ac8fecf8 82 *
valeyev 0:e056ac8fecf8 83 * @param mode PullUp, PullDown, PullNone, OpenDrain
valeyev 0:e056ac8fecf8 84 */
valeyev 0:e056ac8fecf8 85 void mode(PinMode mode) {
valeyev 0:e056ac8fecf8 86 core_util_critical_section_enter();
valeyev 0:e056ac8fecf8 87 port_mode(&_port, mode);
valeyev 0:e056ac8fecf8 88 core_util_critical_section_exit();
valeyev 0:e056ac8fecf8 89 }
valeyev 0:e056ac8fecf8 90
valeyev 0:e056ac8fecf8 91 /** A shorthand for write()
valeyev 0:e056ac8fecf8 92 * \sa PortInOut::write()
valeyev 0:e056ac8fecf8 93 */
valeyev 0:e056ac8fecf8 94 PortInOut& operator= (int value) {
valeyev 0:e056ac8fecf8 95 write(value);
valeyev 0:e056ac8fecf8 96 return *this;
valeyev 0:e056ac8fecf8 97 }
valeyev 0:e056ac8fecf8 98
valeyev 0:e056ac8fecf8 99 /** A shorthand for write()
valeyev 0:e056ac8fecf8 100 * \sa PortInOut::write()
valeyev 0:e056ac8fecf8 101 */
valeyev 0:e056ac8fecf8 102 PortInOut& operator= (PortInOut& rhs) {
valeyev 0:e056ac8fecf8 103 write(rhs.read());
valeyev 0:e056ac8fecf8 104 return *this;
valeyev 0:e056ac8fecf8 105 }
valeyev 0:e056ac8fecf8 106
valeyev 0:e056ac8fecf8 107 /** A shorthand for read()
valeyev 0:e056ac8fecf8 108 * \sa PortInOut::read()
valeyev 0:e056ac8fecf8 109 */
valeyev 0:e056ac8fecf8 110 operator int() {
valeyev 0:e056ac8fecf8 111 return read();
valeyev 0:e056ac8fecf8 112 }
valeyev 0:e056ac8fecf8 113
valeyev 0:e056ac8fecf8 114 private:
valeyev 0:e056ac8fecf8 115 port_t _port;
valeyev 0:e056ac8fecf8 116 };
valeyev 0:e056ac8fecf8 117
valeyev 0:e056ac8fecf8 118 } // namespace mbed
valeyev 0:e056ac8fecf8 119
valeyev 0:e056ac8fecf8 120 #endif
valeyev 0:e056ac8fecf8 121
valeyev 0:e056ac8fecf8 122 #endif