Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

PortOut.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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