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