teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/PortInOut.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff 
This updates the lib to the mbed lib v125

Who changed what in which revision?

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