]>
git.gir.st - tmk_keyboard.git/blob - tmk_core/tool/mbed/mbed-sdk/libraries/mbed/api/PortInOut.h
1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2013 ARM Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 #ifndef MBED_PORTINOUT_H
17 #define MBED_PORTINOUT_H
27 /** A multiple pin digital in/out used to set/read multiple bi-directional pins
32 /** Create an PortInOut, connected to the specified port
34 * @param port Port to connect to (Port0-Port5)
35 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
37 PortInOut(PortName port
, int mask
= 0xFFFFFFFF) {
38 port_init(&_port
, port
, mask
, PIN_INPUT
);
41 /** Write the value to the output port
43 * @param value An integer specifying a bit to write for every corresponding port pin
45 void write(int value
) {
46 port_write(&_port
, value
);
49 /** Read the value currently output on the port
52 * An integer with each bit corresponding to associated port pin setting
55 return port_read(&_port
);
61 port_dir(&_port
, PIN_OUTPUT
);
67 port_dir(&_port
, PIN_INPUT
);
70 /** Set the input pin mode
72 * @param mode PullUp, PullDown, PullNone, OpenDrain
74 void mode(PinMode mode
) {
75 port_mode(&_port
, mode
);
78 /** A shorthand for write()
80 PortInOut
& operator= (int value
) {
85 PortInOut
& operator= (PortInOut
& rhs
) {
90 /** A shorthand for read()