mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/PortInOut.h@151:675da3299148, 2017-09-15 (annotated)

Committer:
AnnaBridge
Date:
Fri Sep 15 14:46:57 2017 +0100
Revision:
151:675da3299148
Parent:
145:64910690c574 
Release 151 of the mbed library.

Who changed what in which revision?

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