Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/PortOut.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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