Martin Gurtner / HKC_MiniCheetah

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.

mbed-dev/drivers/PortOut.h@60:8399756e1ba1, 2021-01-22 (annotated)

Committer:
MartinGurtner
Date:
Fri Jan 22 13:10:37 2021 +0000
Revision:
60:8399756e1ba1
.

Who changed what in which revision?

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