Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/drivers/PortInOut.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

UserRevisionLine numberNew contents of line
lypinator 0:bb348c97df44 1 /* mbed Microcontroller Library
lypinator 0:bb348c97df44 2 * Copyright (c) 2006-2013 ARM Limited
lypinator 0:bb348c97df44 3 *
lypinator 0:bb348c97df44 4 * Licensed under the Apache License, Version 2.0 (the "License");
lypinator 0:bb348c97df44 5 * you may not use this file except in compliance with the License.
lypinator 0:bb348c97df44 6 * You may obtain a copy of the License at
lypinator 0:bb348c97df44 7 *
lypinator 0:bb348c97df44 8 * http://www.apache.org/licenses/LICENSE-2.0
lypinator 0:bb348c97df44 9 *
lypinator 0:bb348c97df44 10 * Unless required by applicable law or agreed to in writing, software
lypinator 0:bb348c97df44 11 * distributed under the License is distributed on an "AS IS" BASIS,
lypinator 0:bb348c97df44 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
lypinator 0:bb348c97df44 13 * See the License for the specific language governing permissions and
lypinator 0:bb348c97df44 14 * limitations under the License.
lypinator 0:bb348c97df44 15 */
lypinator 0:bb348c97df44 16 #ifndef MBED_PORTINOUT_H
lypinator 0:bb348c97df44 17 #define MBED_PORTINOUT_H
lypinator 0:bb348c97df44 18
lypinator 0:bb348c97df44 19 #include "platform/platform.h"
lypinator 0:bb348c97df44 20
lypinator 0:bb348c97df44 21 #if defined (DEVICE_PORTINOUT) || defined(DOXYGEN_ONLY)
lypinator 0:bb348c97df44 22
lypinator 0:bb348c97df44 23 #include "hal/port_api.h"
lypinator 0:bb348c97df44 24 #include "platform/mbed_critical.h"
lypinator 0:bb348c97df44 25
lypinator 0:bb348c97df44 26 namespace mbed {
lypinator 0:bb348c97df44 27 /** \addtogroup drivers */
lypinator 0:bb348c97df44 28
lypinator 0:bb348c97df44 29 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
lypinator 0:bb348c97df44 30 *
lypinator 0:bb348c97df44 31 * @note Synchronization level: Interrupt safe
lypinator 0:bb348c97df44 32 * @ingroup drivers
lypinator 0:bb348c97df44 33 */
lypinator 0:bb348c97df44 34 class PortInOut {
lypinator 0:bb348c97df44 35 public:
lypinator 0:bb348c97df44 36
lypinator 0:bb348c97df44 37 /** Create an PortInOut, connected to the specified port
lypinator 0:bb348c97df44 38 *
lypinator 0:bb348c97df44 39 * @param port Port to connect to (Port0-Port5)
lypinator 0:bb348c97df44 40 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
lypinator 0:bb348c97df44 41 */
lypinator 0:bb348c97df44 42 PortInOut(PortName port, int mask = 0xFFFFFFFF)
lypinator 0:bb348c97df44 43 {
lypinator 0:bb348c97df44 44 core_util_critical_section_enter();
lypinator 0:bb348c97df44 45 port_init(&_port, port, mask, PIN_INPUT);
lypinator 0:bb348c97df44 46 core_util_critical_section_exit();
lypinator 0:bb348c97df44 47 }
lypinator 0:bb348c97df44 48
lypinator 0:bb348c97df44 49 /** Write the value to the output port
lypinator 0:bb348c97df44 50 *
lypinator 0:bb348c97df44 51 * @param value An integer specifying a bit to write for every corresponding port pin
lypinator 0:bb348c97df44 52 */
lypinator 0:bb348c97df44 53 void write(int value)
lypinator 0:bb348c97df44 54 {
lypinator 0:bb348c97df44 55 port_write(&_port, value);
lypinator 0:bb348c97df44 56 }
lypinator 0:bb348c97df44 57
lypinator 0:bb348c97df44 58 /** Read the value currently output on the port
lypinator 0:bb348c97df44 59 *
lypinator 0:bb348c97df44 60 * @returns
lypinator 0:bb348c97df44 61 * An integer with each bit corresponding to associated port pin setting
lypinator 0:bb348c97df44 62 */
lypinator 0:bb348c97df44 63 int read()
lypinator 0:bb348c97df44 64 {
lypinator 0:bb348c97df44 65 return port_read(&_port);
lypinator 0:bb348c97df44 66 }
lypinator 0:bb348c97df44 67
lypinator 0:bb348c97df44 68 /** Set as an output
lypinator 0:bb348c97df44 69 */
lypinator 0:bb348c97df44 70 void output()
lypinator 0:bb348c97df44 71 {
lypinator 0:bb348c97df44 72 core_util_critical_section_enter();
lypinator 0:bb348c97df44 73 port_dir(&_port, PIN_OUTPUT);
lypinator 0:bb348c97df44 74 core_util_critical_section_exit();
lypinator 0:bb348c97df44 75 }
lypinator 0:bb348c97df44 76
lypinator 0:bb348c97df44 77 /** Set as an input
lypinator 0:bb348c97df44 78 */
lypinator 0:bb348c97df44 79 void input()
lypinator 0:bb348c97df44 80 {
lypinator 0:bb348c97df44 81 core_util_critical_section_enter();
lypinator 0:bb348c97df44 82 port_dir(&_port, PIN_INPUT);
lypinator 0:bb348c97df44 83 core_util_critical_section_exit();
lypinator 0:bb348c97df44 84 }
lypinator 0:bb348c97df44 85
lypinator 0:bb348c97df44 86 /** Set the input pin mode
lypinator 0:bb348c97df44 87 *
lypinator 0:bb348c97df44 88 * @param mode PullUp, PullDown, PullNone, OpenDrain
lypinator 0:bb348c97df44 89 */
lypinator 0:bb348c97df44 90 void mode(PinMode mode)
lypinator 0:bb348c97df44 91 {
lypinator 0:bb348c97df44 92 core_util_critical_section_enter();
lypinator 0:bb348c97df44 93 port_mode(&_port, mode);
lypinator 0:bb348c97df44 94 core_util_critical_section_exit();
lypinator 0:bb348c97df44 95 }
lypinator 0:bb348c97df44 96
lypinator 0:bb348c97df44 97 /** A shorthand for write()
lypinator 0:bb348c97df44 98 * \sa PortInOut::write()
lypinator 0:bb348c97df44 99 */
lypinator 0:bb348c97df44 100 PortInOut &operator= (int value)
lypinator 0:bb348c97df44 101 {
lypinator 0:bb348c97df44 102 write(value);
lypinator 0:bb348c97df44 103 return *this;
lypinator 0:bb348c97df44 104 }
lypinator 0:bb348c97df44 105
lypinator 0:bb348c97df44 106 /** A shorthand for write()
lypinator 0:bb348c97df44 107 * \sa PortInOut::write()
lypinator 0:bb348c97df44 108 */
lypinator 0:bb348c97df44 109 PortInOut &operator= (PortInOut &rhs)
lypinator 0:bb348c97df44 110 {
lypinator 0:bb348c97df44 111 write(rhs.read());
lypinator 0:bb348c97df44 112 return *this;
lypinator 0:bb348c97df44 113 }
lypinator 0:bb348c97df44 114
lypinator 0:bb348c97df44 115 /** A shorthand for read()
lypinator 0:bb348c97df44 116 * \sa PortInOut::read()
lypinator 0:bb348c97df44 117 */
lypinator 0:bb348c97df44 118 operator int()
lypinator 0:bb348c97df44 119 {
lypinator 0:bb348c97df44 120 return read();
lypinator 0:bb348c97df44 121 }
lypinator 0:bb348c97df44 122
lypinator 0:bb348c97df44 123 private:
lypinator 0:bb348c97df44 124 port_t _port;
lypinator 0:bb348c97df44 125 };
lypinator 0:bb348c97df44 126
lypinator 0:bb348c97df44 127 } // namespace mbed
lypinator 0:bb348c97df44 128
lypinator 0:bb348c97df44 129 #endif
lypinator 0:bb348c97df44 130
lypinator 0:bb348c97df44 131 #endif