Jhon Plantikow / mbed

.

Dependents:   RTC

PortOut.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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