The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
drivers/PortIn.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- 170:e95d10626187
- Child:
- 172:65be27845400
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 156:ff21514d8981 | 1 | /* mbed Microcontroller Library |
AnnaBridge | 156:ff21514d8981 | 2 | * Copyright (c) 2006-2013 ARM Limited |
AnnaBridge | 156:ff21514d8981 | 3 | * |
AnnaBridge | 156:ff21514d8981 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 156:ff21514d8981 | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 156:ff21514d8981 | 6 | * You may obtain a copy of the License at |
AnnaBridge | 156:ff21514d8981 | 7 | * |
AnnaBridge | 156:ff21514d8981 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 156:ff21514d8981 | 9 | * |
AnnaBridge | 156:ff21514d8981 | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 156:ff21514d8981 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 156:ff21514d8981 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 156:ff21514d8981 | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 156:ff21514d8981 | 14 | * limitations under the License. |
AnnaBridge | 156:ff21514d8981 | 15 | */ |
AnnaBridge | 156:ff21514d8981 | 16 | #ifndef MBED_PORTIN_H |
AnnaBridge | 156:ff21514d8981 | 17 | #define MBED_PORTIN_H |
AnnaBridge | 156:ff21514d8981 | 18 | |
AnnaBridge | 156:ff21514d8981 | 19 | #include "platform/platform.h" |
AnnaBridge | 156:ff21514d8981 | 20 | |
AnnaBridge | 156:ff21514d8981 | 21 | #if defined (DEVICE_PORTIN) || defined(DOXYGEN_ONLY) |
AnnaBridge | 156:ff21514d8981 | 22 | |
AnnaBridge | 156:ff21514d8981 | 23 | #include "hal/port_api.h" |
AnnaBridge | 156:ff21514d8981 | 24 | #include "platform/mbed_critical.h" |
AnnaBridge | 156:ff21514d8981 | 25 | |
AnnaBridge | 156:ff21514d8981 | 26 | namespace mbed { |
AnnaBridge | 156:ff21514d8981 | 27 | /** \addtogroup drivers */ |
AnnaBridge | 156:ff21514d8981 | 28 | |
AnnaBridge | 156:ff21514d8981 | 29 | /** A multiple pin digital input |
AnnaBridge | 156:ff21514d8981 | 30 | * |
AnnaBridge | 156:ff21514d8981 | 31 | * @note Synchronization level: Interrupt safe |
AnnaBridge | 156:ff21514d8981 | 32 | * |
AnnaBridge | 156:ff21514d8981 | 33 | * Example: |
AnnaBridge | 156:ff21514d8981 | 34 | * @code |
AnnaBridge | 171:3a7713b1edbc | 35 | * // Turn on an LED if any pins of Port2[0:5] are high |
AnnaBridge | 156:ff21514d8981 | 36 | * |
AnnaBridge | 156:ff21514d8981 | 37 | * #include "mbed.h" |
AnnaBridge | 156:ff21514d8981 | 38 | * |
AnnaBridge | 171:3a7713b1edbc | 39 | * PortIn p(Port2, 0x0000003F); // Port2 pins [0:5] only |
AnnaBridge | 171:3a7713b1edbc | 40 | * DigitalOut led(LED4); |
AnnaBridge | 156:ff21514d8981 | 41 | * |
AnnaBridge | 156:ff21514d8981 | 42 | * int main() { |
AnnaBridge | 156:ff21514d8981 | 43 | * while(1) { |
AnnaBridge | 156:ff21514d8981 | 44 | * int pins = p.read(); |
AnnaBridge | 156:ff21514d8981 | 45 | * if(pins) { |
AnnaBridge | 171:3a7713b1edbc | 46 | * led = 1; |
AnnaBridge | 156:ff21514d8981 | 47 | * } else { |
AnnaBridge | 171:3a7713b1edbc | 48 | * led = 0; |
AnnaBridge | 156:ff21514d8981 | 49 | * } |
AnnaBridge | 156:ff21514d8981 | 50 | * } |
AnnaBridge | 156:ff21514d8981 | 51 | * } |
AnnaBridge | 156:ff21514d8981 | 52 | * @endcode |
AnnaBridge | 156:ff21514d8981 | 53 | * @ingroup drivers |
AnnaBridge | 156:ff21514d8981 | 54 | */ |
AnnaBridge | 156:ff21514d8981 | 55 | class PortIn { |
AnnaBridge | 156:ff21514d8981 | 56 | public: |
AnnaBridge | 156:ff21514d8981 | 57 | |
AnnaBridge | 171:3a7713b1edbc | 58 | /** Create a PortIn, connected to the specified port |
AnnaBridge | 156:ff21514d8981 | 59 | * |
AnnaBridge | 171:3a7713b1edbc | 60 | * @param port Port to connect to (as defined in target's PortNames.h) |
AnnaBridge | 171:3a7713b1edbc | 61 | * @param mask Bitmask defines which port pins should be an input (0 - ignore, 1 - include) |
AnnaBridge | 156:ff21514d8981 | 62 | */ |
AnnaBridge | 170:e95d10626187 | 63 | PortIn(PortName port, int mask = 0xFFFFFFFF) |
AnnaBridge | 170:e95d10626187 | 64 | { |
AnnaBridge | 156:ff21514d8981 | 65 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 66 | port_init(&_port, port, mask, PIN_INPUT); |
AnnaBridge | 156:ff21514d8981 | 67 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 68 | } |
AnnaBridge | 156:ff21514d8981 | 69 | |
AnnaBridge | 171:3a7713b1edbc | 70 | /** Read the value input to the port |
AnnaBridge | 156:ff21514d8981 | 71 | * |
AnnaBridge | 156:ff21514d8981 | 72 | * @returns |
AnnaBridge | 171:3a7713b1edbc | 73 | * An integer with each bit corresponding to the associated pin value |
AnnaBridge | 156:ff21514d8981 | 74 | */ |
AnnaBridge | 170:e95d10626187 | 75 | int read() |
AnnaBridge | 170:e95d10626187 | 76 | { |
AnnaBridge | 156:ff21514d8981 | 77 | return port_read(&_port); |
AnnaBridge | 156:ff21514d8981 | 78 | } |
AnnaBridge | 156:ff21514d8981 | 79 | |
AnnaBridge | 156:ff21514d8981 | 80 | /** Set the input pin mode |
AnnaBridge | 156:ff21514d8981 | 81 | * |
AnnaBridge | 156:ff21514d8981 | 82 | * @param mode PullUp, PullDown, PullNone, OpenDrain |
AnnaBridge | 156:ff21514d8981 | 83 | */ |
AnnaBridge | 170:e95d10626187 | 84 | void mode(PinMode mode) |
AnnaBridge | 170:e95d10626187 | 85 | { |
AnnaBridge | 156:ff21514d8981 | 86 | core_util_critical_section_enter(); |
AnnaBridge | 156:ff21514d8981 | 87 | port_mode(&_port, mode); |
AnnaBridge | 156:ff21514d8981 | 88 | core_util_critical_section_exit(); |
AnnaBridge | 156:ff21514d8981 | 89 | } |
AnnaBridge | 156:ff21514d8981 | 90 | |
AnnaBridge | 156:ff21514d8981 | 91 | /** A shorthand for read() |
AnnaBridge | 156:ff21514d8981 | 92 | */ |
AnnaBridge | 170:e95d10626187 | 93 | operator int() |
AnnaBridge | 170:e95d10626187 | 94 | { |
AnnaBridge | 156:ff21514d8981 | 95 | return read(); |
AnnaBridge | 156:ff21514d8981 | 96 | } |
AnnaBridge | 156:ff21514d8981 | 97 | |
AnnaBridge | 156:ff21514d8981 | 98 | private: |
AnnaBridge | 156:ff21514d8981 | 99 | port_t _port; |
AnnaBridge | 156:ff21514d8981 | 100 | }; |
AnnaBridge | 156:ff21514d8981 | 101 | |
AnnaBridge | 156:ff21514d8981 | 102 | } // namespace mbed |
AnnaBridge | 156:ff21514d8981 | 103 | |
AnnaBridge | 156:ff21514d8981 | 104 | #endif |
AnnaBridge | 156:ff21514d8981 | 105 | |
AnnaBridge | 156:ff21514d8981 | 106 | #endif |