Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/PortInOut.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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