mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/PortInOut.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
167:e84263d55307
Child:
189:f392fc9709a3
mbed-dev library. Release version 163

Who changed what in which revision?

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