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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/PortInOut.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_PORTINOUT_H
ommpy 0:d383e2dee0f7 18 #define MBED_PORTINOUT_H
ommpy 0:d383e2dee0f7 19
ommpy 0:d383e2dee0f7 20 #include "platform/platform.h"
ommpy 0:d383e2dee0f7 21
ommpy 0:d383e2dee0f7 22 #if DEVICE_PORTINOUT || 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 in/out used to set/read multiple bi-directional pins
ommpy 0:d383e2dee0f7 31 *
ommpy 0:d383e2dee0f7 32 * @note Synchronization level: Interrupt safe
ommpy 0:d383e2dee0f7 33 * @ingroup drivers
ommpy 0:d383e2dee0f7 34 */
ommpy 0:d383e2dee0f7 35 class PortInOut {
ommpy 0:d383e2dee0f7 36 public:
ommpy 0:d383e2dee0f7 37
ommpy 0:d383e2dee0f7 38 /** Create an PortInOut, connected to the specified port
ommpy 0:d383e2dee0f7 39 *
ommpy 0:d383e2dee0f7 40 * @param port Port to connect to (Port0-Port5)
ommpy 0:d383e2dee0f7 41 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
ommpy 0:d383e2dee0f7 42 */
ommpy 0:d383e2dee0f7 43 PortInOut(PortName port, int mask = 0xFFFFFFFF)
ommpy 0:d383e2dee0f7 44 {
ommpy 0:d383e2dee0f7 45 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 46 port_init(&_port, port, mask, PIN_INPUT);
ommpy 0:d383e2dee0f7 47 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 48 }
ommpy 0:d383e2dee0f7 49
ommpy 0:d383e2dee0f7 50 /** Write the value to the output port
ommpy 0:d383e2dee0f7 51 *
ommpy 0:d383e2dee0f7 52 * @param value An integer specifying a bit to write for every corresponding port pin
ommpy 0:d383e2dee0f7 53 */
ommpy 0:d383e2dee0f7 54 void write(int value)
ommpy 0:d383e2dee0f7 55 {
ommpy 0:d383e2dee0f7 56 port_write(&_port, value);
ommpy 0:d383e2dee0f7 57 }
ommpy 0:d383e2dee0f7 58
ommpy 0:d383e2dee0f7 59 /** Read the value currently output on the port
ommpy 0:d383e2dee0f7 60 *
ommpy 0:d383e2dee0f7 61 * @returns
ommpy 0:d383e2dee0f7 62 * An integer with each bit corresponding to associated port pin setting
ommpy 0:d383e2dee0f7 63 */
ommpy 0:d383e2dee0f7 64 int read()
ommpy 0:d383e2dee0f7 65 {
ommpy 0:d383e2dee0f7 66 return port_read(&_port);
ommpy 0:d383e2dee0f7 67 }
ommpy 0:d383e2dee0f7 68
ommpy 0:d383e2dee0f7 69 /** Set as an output
ommpy 0:d383e2dee0f7 70 */
ommpy 0:d383e2dee0f7 71 void output()
ommpy 0:d383e2dee0f7 72 {
ommpy 0:d383e2dee0f7 73 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 74 port_dir(&_port, PIN_OUTPUT);
ommpy 0:d383e2dee0f7 75 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 76 }
ommpy 0:d383e2dee0f7 77
ommpy 0:d383e2dee0f7 78 /** Set as an input
ommpy 0:d383e2dee0f7 79 */
ommpy 0:d383e2dee0f7 80 void input()
ommpy 0:d383e2dee0f7 81 {
ommpy 0:d383e2dee0f7 82 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 83 port_dir(&_port, PIN_INPUT);
ommpy 0:d383e2dee0f7 84 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 85 }
ommpy 0:d383e2dee0f7 86
ommpy 0:d383e2dee0f7 87 /** Set the input pin mode
ommpy 0:d383e2dee0f7 88 *
ommpy 0:d383e2dee0f7 89 * @param mode PullUp, PullDown, PullNone, OpenDrain
ommpy 0:d383e2dee0f7 90 */
ommpy 0:d383e2dee0f7 91 void mode(PinMode mode)
ommpy 0:d383e2dee0f7 92 {
ommpy 0:d383e2dee0f7 93 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 94 port_mode(&_port, mode);
ommpy 0:d383e2dee0f7 95 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 96 }
ommpy 0:d383e2dee0f7 97
ommpy 0:d383e2dee0f7 98 /** A shorthand for write()
ommpy 0:d383e2dee0f7 99 * \sa PortInOut::write()
ommpy 0:d383e2dee0f7 100 */
ommpy 0:d383e2dee0f7 101 PortInOut &operator= (int value)
ommpy 0:d383e2dee0f7 102 {
ommpy 0:d383e2dee0f7 103 write(value);
ommpy 0:d383e2dee0f7 104 return *this;
ommpy 0:d383e2dee0f7 105 }
ommpy 0:d383e2dee0f7 106
ommpy 0:d383e2dee0f7 107 /** A shorthand for write()
ommpy 0:d383e2dee0f7 108 * \sa PortInOut::write()
ommpy 0:d383e2dee0f7 109 */
ommpy 0:d383e2dee0f7 110 PortInOut &operator= (PortInOut &rhs)
ommpy 0:d383e2dee0f7 111 {
ommpy 0:d383e2dee0f7 112 write(rhs.read());
ommpy 0:d383e2dee0f7 113 return *this;
ommpy 0:d383e2dee0f7 114 }
ommpy 0:d383e2dee0f7 115
ommpy 0:d383e2dee0f7 116 /** A shorthand for read()
ommpy 0:d383e2dee0f7 117 * \sa PortInOut::read()
ommpy 0:d383e2dee0f7 118 */
ommpy 0:d383e2dee0f7 119 operator int()
ommpy 0:d383e2dee0f7 120 {
ommpy 0:d383e2dee0f7 121 return read();
ommpy 0:d383e2dee0f7 122 }
ommpy 0:d383e2dee0f7 123
ommpy 0:d383e2dee0f7 124 private:
ommpy 0:d383e2dee0f7 125 port_t _port;
ommpy 0:d383e2dee0f7 126 };
ommpy 0:d383e2dee0f7 127
ommpy 0:d383e2dee0f7 128 } // namespace mbed
ommpy 0:d383e2dee0f7 129
ommpy 0:d383e2dee0f7 130 #endif
ommpy 0:d383e2dee0f7 131
ommpy 0:d383e2dee0f7 132 #endif