]>
git.gir.st - tmk_keyboard.git/blob - tmk_core/tool/mbed/mbed-sdk/libraries/mbed/api/PortOut.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_PORTOUT_H
17 #define MBED_PORTOUT_H
26 /** A multiple pin digital out
30 * // Toggle all four LEDs
34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
35 * #define LED_MASK 0x00B40000
37 * PortOut ledport(Port1, LED_MASK);
52 /** Create an PortOut, connected to the specified port
54 * @param port Port to connect to (Port0-Port5)
55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
57 PortOut(PortName port
, int mask
= 0xFFFFFFFF) {
58 port_init(&_port
, port
, mask
, PIN_OUTPUT
);
61 /** Write the value to the output port
63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
65 void write(int value
) {
66 port_write(&_port
, value
);
69 /** Read the value currently output on the port
72 * An integer with each bit corresponding to associated PortOut pin setting
75 return port_read(&_port
);
78 /** A shorthand for write()
80 PortOut
& operator= (int value
) {
85 PortOut
& operator= (PortOut
& rhs
) {
90 /** A shorthand for read()