Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/PortInOut.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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