Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

PortOut.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
65:5798e58a58b1 
dgdgr

Who changed what in which revision?

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