Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/PortInOut.h@563:9f26fcd0c9ce, 2015-06-09 (annotated)

Committer:
mbed_official
Date:
Tue Jun 09 15:30:08 2015 +0100
Revision:
563:9f26fcd0c9ce
Parent:
13:0645d8841f51 
Synchronized with git revision a140fc60a6f74003a3d46c4ce8bf8c742148b9fd



Full URL: https://github.com/mbedmicro/mbed/commit/a140fc60a6f74003a3d46c4ce8bf8c742148b9fd/

Who changed what in which revision?

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