Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/PortIn.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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