Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

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