Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/PortOut.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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