Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/PortOut.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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