Ermanno Brusadin / mbed-src

mbed library sources

api/PortOut.h@0:0a673c671a56, 2016-07-27 (annotated)

Committer:
ebrus
Date:
Wed Jul 27 18:35:32 2016 +0000
Revision:
0:0a673c671a56
4

Who changed what in which revision?

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