Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

PortOut.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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