R L / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/PortInOut.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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