zhang boie / mbed-dev-f30333

drivers/PortIn.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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