Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/PortOut.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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