Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/PortIn.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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