Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/PortOut.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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