teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/PortOut.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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