Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/PortInOut.h@20:fbc6173aa5b2, 2016-04-06 (annotated)

Committer:
Christopher Haster
Date:
Wed Apr 06 09:41:33 2016 -0500
Revision:
20:fbc6173aa5b2
Parent:
0:9c59db1fbc9e 
Added Binder class for statically allocated function binding

Who changed what in which revision?

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