Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

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