BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/drivers/PortIn.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:02dd72d1d465 1 /* mbed Microcontroller Library
borlanic 0:02dd72d1d465 2 * Copyright (c) 2006-2013 ARM Limited
borlanic 0:02dd72d1d465 3 *
borlanic 0:02dd72d1d465 4 * Licensed under the Apache License, Version 2.0 (the "License");
borlanic 0:02dd72d1d465 5 * you may not use this file except in compliance with the License.
borlanic 0:02dd72d1d465 6 * You may obtain a copy of the License at
borlanic 0:02dd72d1d465 7 *
borlanic 0:02dd72d1d465 8 * http://www.apache.org/licenses/LICENSE-2.0
borlanic 0:02dd72d1d465 9 *
borlanic 0:02dd72d1d465 10 * Unless required by applicable law or agreed to in writing, software
borlanic 0:02dd72d1d465 11 * distributed under the License is distributed on an "AS IS" BASIS,
borlanic 0:02dd72d1d465 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
borlanic 0:02dd72d1d465 13 * See the License for the specific language governing permissions and
borlanic 0:02dd72d1d465 14 * limitations under the License.
borlanic 0:02dd72d1d465 15 */
borlanic 0:02dd72d1d465 16 #ifndef MBED_PORTIN_H
borlanic 0:02dd72d1d465 17 #define MBED_PORTIN_H
borlanic 0:02dd72d1d465 18
borlanic 0:02dd72d1d465 19 #include "platform/platform.h"
borlanic 0:02dd72d1d465 20
borlanic 0:02dd72d1d465 21 #if defined (DEVICE_PORTIN) || defined(DOXYGEN_ONLY)
borlanic 0:02dd72d1d465 22
borlanic 0:02dd72d1d465 23 #include "hal/port_api.h"
borlanic 0:02dd72d1d465 24 #include "platform/mbed_critical.h"
borlanic 0:02dd72d1d465 25
borlanic 0:02dd72d1d465 26 namespace mbed {
borlanic 0:02dd72d1d465 27 /** \addtogroup drivers */
borlanic 0:02dd72d1d465 28
borlanic 0:02dd72d1d465 29 /** A multiple pin digital input
borlanic 0:02dd72d1d465 30 *
borlanic 0:02dd72d1d465 31 * @note Synchronization level: Interrupt safe
borlanic 0:02dd72d1d465 32 *
borlanic 0:02dd72d1d465 33 * Example:
borlanic 0:02dd72d1d465 34 * @code
borlanic 0:02dd72d1d465 35 * // Switch on an LED if any of mbed pins 21-26 is high
borlanic 0:02dd72d1d465 36 *
borlanic 0:02dd72d1d465 37 * #include "mbed.h"
borlanic 0:02dd72d1d465 38 *
borlanic 0:02dd72d1d465 39 * PortIn p(Port2, 0x0000003F); // p21-p26
borlanic 0:02dd72d1d465 40 * DigitalOut ind(LED4);
borlanic 0:02dd72d1d465 41 *
borlanic 0:02dd72d1d465 42 * int main() {
borlanic 0:02dd72d1d465 43 * while(1) {
borlanic 0:02dd72d1d465 44 * int pins = p.read();
borlanic 0:02dd72d1d465 45 * if(pins) {
borlanic 0:02dd72d1d465 46 * ind = 1;
borlanic 0:02dd72d1d465 47 * } else {
borlanic 0:02dd72d1d465 48 * ind = 0;
borlanic 0:02dd72d1d465 49 * }
borlanic 0:02dd72d1d465 50 * }
borlanic 0:02dd72d1d465 51 * }
borlanic 0:02dd72d1d465 52 * @endcode
borlanic 0:02dd72d1d465 53 * @ingroup drivers
borlanic 0:02dd72d1d465 54 */
borlanic 0:02dd72d1d465 55 class PortIn {
borlanic 0:02dd72d1d465 56 public:
borlanic 0:02dd72d1d465 57
borlanic 0:02dd72d1d465 58 /** Create an PortIn, connected to the specified port
borlanic 0:02dd72d1d465 59 *
borlanic 0:02dd72d1d465 60 * @param port Port to connect to (Port0-Port5)
borlanic 0:02dd72d1d465 61 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
borlanic 0:02dd72d1d465 62 */
borlanic 0:02dd72d1d465 63 PortIn(PortName port, int mask = 0xFFFFFFFF) {
borlanic 0:02dd72d1d465 64 core_util_critical_section_enter();
borlanic 0:02dd72d1d465 65 port_init(&_port, port, mask, PIN_INPUT);
borlanic 0:02dd72d1d465 66 core_util_critical_section_exit();
borlanic 0:02dd72d1d465 67 }
borlanic 0:02dd72d1d465 68
borlanic 0:02dd72d1d465 69 /** Read the value currently output on the port
borlanic 0:02dd72d1d465 70 *
borlanic 0:02dd72d1d465 71 * @returns
borlanic 0:02dd72d1d465 72 * An integer with each bit corresponding to associated port pin setting
borlanic 0:02dd72d1d465 73 */
borlanic 0:02dd72d1d465 74 int read() {
borlanic 0:02dd72d1d465 75 return port_read(&_port);
borlanic 0:02dd72d1d465 76 }
borlanic 0:02dd72d1d465 77
borlanic 0:02dd72d1d465 78 /** Set the input pin mode
borlanic 0:02dd72d1d465 79 *
borlanic 0:02dd72d1d465 80 * @param mode PullUp, PullDown, PullNone, OpenDrain
borlanic 0:02dd72d1d465 81 */
borlanic 0:02dd72d1d465 82 void mode(PinMode mode) {
borlanic 0:02dd72d1d465 83 core_util_critical_section_enter();
borlanic 0:02dd72d1d465 84 port_mode(&_port, mode);
borlanic 0:02dd72d1d465 85 core_util_critical_section_exit();
borlanic 0:02dd72d1d465 86 }
borlanic 0:02dd72d1d465 87
borlanic 0:02dd72d1d465 88 /** A shorthand for read()
borlanic 0:02dd72d1d465 89 */
borlanic 0:02dd72d1d465 90 operator int() {
borlanic 0:02dd72d1d465 91 return read();
borlanic 0:02dd72d1d465 92 }
borlanic 0:02dd72d1d465 93
borlanic 0:02dd72d1d465 94 private:
borlanic 0:02dd72d1d465 95 port_t _port;
borlanic 0:02dd72d1d465 96 };
borlanic 0:02dd72d1d465 97
borlanic 0:02dd72d1d465 98 } // namespace mbed
borlanic 0:02dd72d1d465 99
borlanic 0:02dd72d1d465 100 #endif
borlanic 0:02dd72d1d465 101
borlanic 0:02dd72d1d465 102 #endif