Tomo Yamanaka / mbed-dev

mbed library sources. Supersedes mbed-src. GR-PEACH runs on RAM.

Fork of mbed-dev by mbed official

api/PortOut.h@103:493a29d2d4d7, 2016-03-30 (annotated)

Committer:
1050186
Date:
Wed Mar 30 11:41:25 2016 +0000
Revision:
103:493a29d2d4d7
Parent:
0:9b334a45a8ff 
GR-PEACH runs on RAM.

Who changed what in which revision?

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