Jhon Plantikow / Dataloger

Dataloger

PortOut.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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