Gan likun / mbed-dev

00

drivers/PortIn.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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