Lancaster University / mbed-dev-bin

Binary version of Lancaster University's mbed branch, soon to be merged. The source lives here:https://developer.mbed.org/teams/Lancaster-University/code/mbed-src/

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal ... more

Fork of mbed-lite-test by Lancaster University

PortOut.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

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