mbed official / mbed

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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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