Gan likun / mbed1-dev

001

drivers/PortInOut.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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