mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/PortOut.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
145:64910690c574 
Release 147 of the mbed library.

Who changed what in which revision?

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