ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

PortOut.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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