DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/PortOut.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

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