DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/PortIn.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_PORTIN_H
elessair 0:7e2bd16f80af 17 #define MBED_PORTIN_H
elessair 0:7e2bd16f80af 18
elessair 0:7e2bd16f80af 19 #include "platform.h"
elessair 0:7e2bd16f80af 20
elessair 0:7e2bd16f80af 21 #if DEVICE_PORTIN
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
elessair 0:7e2bd16f80af 27 /** A multiple pin digital input
elessair 0:7e2bd16f80af 28 *
elessair 0:7e2bd16f80af 29 * Example:
elessair 0:7e2bd16f80af 30 * @code
elessair 0:7e2bd16f80af 31 * // Switch on an LED if any of mbed pins 21-26 is high
elessair 0:7e2bd16f80af 32 *
elessair 0:7e2bd16f80af 33 * #include "mbed.h"
elessair 0:7e2bd16f80af 34 *
elessair 0:7e2bd16f80af 35 * PortIn p(Port2, 0x0000003F); // p21-p26
elessair 0:7e2bd16f80af 36 * DigitalOut ind(LED4);
elessair 0:7e2bd16f80af 37 *
elessair 0:7e2bd16f80af 38 * int main() {
elessair 0:7e2bd16f80af 39 * while(1) {
elessair 0:7e2bd16f80af 40 * int pins = p.read();
elessair 0:7e2bd16f80af 41 * if(pins) {
elessair 0:7e2bd16f80af 42 * ind = 1;
elessair 0:7e2bd16f80af 43 * } else {
elessair 0:7e2bd16f80af 44 * ind = 0;
elessair 0:7e2bd16f80af 45 * }
elessair 0:7e2bd16f80af 46 * }
elessair 0:7e2bd16f80af 47 * }
elessair 0:7e2bd16f80af 48 * @endcode
elessair 0:7e2bd16f80af 49 */
elessair 0:7e2bd16f80af 50 class PortIn {
elessair 0:7e2bd16f80af 51 public:
elessair 0:7e2bd16f80af 52
elessair 0:7e2bd16f80af 53 /** Create an PortIn, connected to the specified port
elessair 0:7e2bd16f80af 54 *
elessair 0:7e2bd16f80af 55 * @param port Port to connect to (Port0-Port5)
elessair 0:7e2bd16f80af 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
elessair 0:7e2bd16f80af 57 */
elessair 0:7e2bd16f80af 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
elessair 0:7e2bd16f80af 59 port_init(&_port, port, mask, PIN_INPUT);
elessair 0:7e2bd16f80af 60 }
elessair 0:7e2bd16f80af 61
elessair 0:7e2bd16f80af 62 /** Read the value currently output on the port
elessair 0:7e2bd16f80af 63 *
elessair 0:7e2bd16f80af 64 * @returns
elessair 0:7e2bd16f80af 65 * An integer with each bit corresponding to associated port pin setting
elessair 0:7e2bd16f80af 66 */
elessair 0:7e2bd16f80af 67 int read() {
elessair 0:7e2bd16f80af 68 return port_read(&_port);
elessair 0:7e2bd16f80af 69 }
elessair 0:7e2bd16f80af 70
elessair 0:7e2bd16f80af 71 /** Set the input pin mode
elessair 0:7e2bd16f80af 72 *
elessair 0:7e2bd16f80af 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
elessair 0:7e2bd16f80af 74 */
elessair 0:7e2bd16f80af 75 void mode(PinMode mode) {
elessair 0:7e2bd16f80af 76 port_mode(&_port, mode);
elessair 0:7e2bd16f80af 77 }
elessair 0:7e2bd16f80af 78
elessair 0:7e2bd16f80af 79 /** A shorthand for read()
elessair 0:7e2bd16f80af 80 */
elessair 0:7e2bd16f80af 81 operator int() {
elessair 0:7e2bd16f80af 82 return read();
elessair 0:7e2bd16f80af 83 }
elessair 0:7e2bd16f80af 84
elessair 0:7e2bd16f80af 85 private:
elessair 0:7e2bd16f80af 86 port_t _port;
elessair 0:7e2bd16f80af 87 };
elessair 0:7e2bd16f80af 88
elessair 0:7e2bd16f80af 89 } // namespace mbed
elessair 0:7e2bd16f80af 90
elessair 0:7e2bd16f80af 91 #endif
elessair 0:7e2bd16f80af 92
elessair 0:7e2bd16f80af 93 #endif