Vladimir Vana / mbed

pro vyuku PSS v Jecne

PortOut.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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