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/PortIn.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_PORTIN_H
dgabino 0:c76361bd82e8 17 #define MBED_PORTIN_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include "platform.h"
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #if DEVICE_PORTIN
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
dgabino 0:c76361bd82e8 28 /** A multiple pin digital input
dgabino 0:c76361bd82e8 29 *
dgabino 0:c76361bd82e8 30 * @Note Synchronization level: Interrupt safe
dgabino 0:c76361bd82e8 31 *
dgabino 0:c76361bd82e8 32 * Example:
dgabino 0:c76361bd82e8 33 * @code
dgabino 0:c76361bd82e8 34 * // Switch on an LED if any of mbed pins 21-26 is high
dgabino 0:c76361bd82e8 35 *
dgabino 0:c76361bd82e8 36 * #include "mbed.h"
dgabino 0:c76361bd82e8 37 *
dgabino 0:c76361bd82e8 38 * PortIn p(Port2, 0x0000003F); // p21-p26
dgabino 0:c76361bd82e8 39 * DigitalOut ind(LED4);
dgabino 0:c76361bd82e8 40 *
dgabino 0:c76361bd82e8 41 * int main() {
dgabino 0:c76361bd82e8 42 * while(1) {
dgabino 0:c76361bd82e8 43 * int pins = p.read();
dgabino 0:c76361bd82e8 44 * if(pins) {
dgabino 0:c76361bd82e8 45 * ind = 1;
dgabino 0:c76361bd82e8 46 * } else {
dgabino 0:c76361bd82e8 47 * ind = 0;
dgabino 0:c76361bd82e8 48 * }
dgabino 0:c76361bd82e8 49 * }
dgabino 0:c76361bd82e8 50 * }
dgabino 0:c76361bd82e8 51 * @endcode
dgabino 0:c76361bd82e8 52 */
dgabino 0:c76361bd82e8 53 class PortIn {
dgabino 0:c76361bd82e8 54 public:
dgabino 0:c76361bd82e8 55
dgabino 0:c76361bd82e8 56 /** Create an PortIn, connected to the specified port
dgabino 0:c76361bd82e8 57 *
dgabino 0:c76361bd82e8 58 * @param port Port to connect to (Port0-Port5)
dgabino 0:c76361bd82e8 59 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
dgabino 0:c76361bd82e8 60 */
dgabino 0:c76361bd82e8 61 PortIn(PortName port, int mask = 0xFFFFFFFF) {
dgabino 0:c76361bd82e8 62 core_util_critical_section_enter();
dgabino 0:c76361bd82e8 63 port_init(&_port, port, mask, PIN_INPUT);
dgabino 0:c76361bd82e8 64 core_util_critical_section_exit();
dgabino 0:c76361bd82e8 65 }
dgabino 0:c76361bd82e8 66
dgabino 0:c76361bd82e8 67 /** Read the value currently output on the port
dgabino 0:c76361bd82e8 68 *
dgabino 0:c76361bd82e8 69 * @returns
dgabino 0:c76361bd82e8 70 * An integer with each bit corresponding to associated port pin setting
dgabino 0:c76361bd82e8 71 */
dgabino 0:c76361bd82e8 72 int read() {
dgabino 0:c76361bd82e8 73 return port_read(&_port);
dgabino 0:c76361bd82e8 74 }
dgabino 0:c76361bd82e8 75
dgabino 0:c76361bd82e8 76 /** Set the input pin mode
dgabino 0:c76361bd82e8 77 *
dgabino 0:c76361bd82e8 78 * @param mode PullUp, PullDown, PullNone, OpenDrain
dgabino 0:c76361bd82e8 79 */
dgabino 0:c76361bd82e8 80 void mode(PinMode mode) {
dgabino 0:c76361bd82e8 81 core_util_critical_section_enter();
dgabino 0:c76361bd82e8 82 port_mode(&_port, mode);
dgabino 0:c76361bd82e8 83 core_util_critical_section_exit();
dgabino 0:c76361bd82e8 84 }
dgabino 0:c76361bd82e8 85
dgabino 0:c76361bd82e8 86 /** A shorthand for read()
dgabino 0:c76361bd82e8 87 */
dgabino 0:c76361bd82e8 88 operator int() {
dgabino 0:c76361bd82e8 89 return read();
dgabino 0:c76361bd82e8 90 }
dgabino 0:c76361bd82e8 91
dgabino 0:c76361bd82e8 92 private:
dgabino 0:c76361bd82e8 93 port_t _port;
dgabino 0:c76361bd82e8 94 };
dgabino 0:c76361bd82e8 95
dgabino 0:c76361bd82e8 96 } // namespace mbed
dgabino 0:c76361bd82e8 97
dgabino 0:c76361bd82e8 98 #endif
dgabino 0:c76361bd82e8 99
dgabino 0:c76361bd82e8 100 #endif