Gan likun / mbed-dev11

1232

drivers/PortIn.h@0:06036f8bee2d, 23 months ago (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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