Juan Salazar / mbed

test

Dependents:   robotic_fish_7

PortOut.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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