jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

PortIn.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 65:5798e58a58b1 1 /* mbed Microcontroller Library
bogdanm 65:5798e58a58b1 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 65:5798e58a58b1 3 *
bogdanm 65:5798e58a58b1 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 65:5798e58a58b1 5 * you may not use this file except in compliance with the License.
bogdanm 65:5798e58a58b1 6 * You may obtain a copy of the License at
bogdanm 65:5798e58a58b1 7 *
bogdanm 65:5798e58a58b1 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 65:5798e58a58b1 9 *
bogdanm 65:5798e58a58b1 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 65:5798e58a58b1 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 65:5798e58a58b1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 65:5798e58a58b1 13 * See the License for the specific language governing permissions and
bogdanm 65:5798e58a58b1 14 * limitations under the License.
bogdanm 65:5798e58a58b1 15 */
bogdanm 65:5798e58a58b1 16 #ifndef MBED_PORTIN_H
bogdanm 65:5798e58a58b1 17 #define MBED_PORTIN_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 #include "platform.h"
bogdanm 65:5798e58a58b1 20
bogdanm 65:5798e58a58b1 21 #if DEVICE_PORTIN
bogdanm 65:5798e58a58b1 22
bogdanm 65:5798e58a58b1 23 #include "port_api.h"
bogdanm 65:5798e58a58b1 24
bogdanm 65:5798e58a58b1 25 namespace mbed {
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 /** A multiple pin digital input
bogdanm 65:5798e58a58b1 28 *
bogdanm 65:5798e58a58b1 29 * Example:
bogdanm 65:5798e58a58b1 30 * @code
bogdanm 65:5798e58a58b1 31 * // Switch on an LED if any of mbed pins 21-26 is high
bogdanm 65:5798e58a58b1 32 *
bogdanm 65:5798e58a58b1 33 * #include "mbed.h"
bogdanm 65:5798e58a58b1 34 *
bogdanm 65:5798e58a58b1 35 * PortIn p(Port2, 0x0000003F); // p21-p26
bogdanm 65:5798e58a58b1 36 * DigitalOut ind(LED4);
bogdanm 65:5798e58a58b1 37 *
bogdanm 65:5798e58a58b1 38 * int main() {
bogdanm 65:5798e58a58b1 39 * while(1) {
bogdanm 65:5798e58a58b1 40 * int pins = p.read();
bogdanm 65:5798e58a58b1 41 * if(pins) {
bogdanm 65:5798e58a58b1 42 * ind = 1;
bogdanm 65:5798e58a58b1 43 * } else {
bogdanm 65:5798e58a58b1 44 * ind = 0;
bogdanm 65:5798e58a58b1 45 * }
bogdanm 65:5798e58a58b1 46 * }
bogdanm 65:5798e58a58b1 47 * }
bogdanm 65:5798e58a58b1 48 * @endcode
bogdanm 65:5798e58a58b1 49 */
bogdanm 65:5798e58a58b1 50 class PortIn {
bogdanm 65:5798e58a58b1 51 public:
bogdanm 65:5798e58a58b1 52
bogdanm 65:5798e58a58b1 53 /** Create an PortIn, connected to the specified port
bogdanm 65:5798e58a58b1 54 *
bogdanm 65:5798e58a58b1 55 * @param port Port to connect to (Port0-Port5)
bogdanm 65:5798e58a58b1 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
bogdanm 65:5798e58a58b1 57 */
bogdanm 65:5798e58a58b1 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
bogdanm 65:5798e58a58b1 59 port_init(&_port, port, mask, PIN_INPUT);
bogdanm 65:5798e58a58b1 60 }
bogdanm 65:5798e58a58b1 61
bogdanm 65:5798e58a58b1 62 /** Read the value currently output on the port
bogdanm 65:5798e58a58b1 63 *
bogdanm 65:5798e58a58b1 64 * @returns
bogdanm 65:5798e58a58b1 65 * An integer with each bit corresponding to associated port pin setting
bogdanm 65:5798e58a58b1 66 */
bogdanm 65:5798e58a58b1 67 int read() {
bogdanm 65:5798e58a58b1 68 return port_read(&_port);
bogdanm 65:5798e58a58b1 69 }
bogdanm 65:5798e58a58b1 70
bogdanm 65:5798e58a58b1 71 /** Set the input pin mode
bogdanm 65:5798e58a58b1 72 *
bogdanm 65:5798e58a58b1 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
bogdanm 65:5798e58a58b1 74 */
bogdanm 65:5798e58a58b1 75 void mode(PinMode mode) {
bogdanm 65:5798e58a58b1 76 port_mode(&_port, mode);
bogdanm 65:5798e58a58b1 77 }
bogdanm 65:5798e58a58b1 78
bogdanm 65:5798e58a58b1 79 /** A shorthand for read()
bogdanm 65:5798e58a58b1 80 */
bogdanm 65:5798e58a58b1 81 operator int() {
bogdanm 65:5798e58a58b1 82 return read();
bogdanm 65:5798e58a58b1 83 }
bogdanm 65:5798e58a58b1 84
bogdanm 65:5798e58a58b1 85 private:
bogdanm 65:5798e58a58b1 86 port_t _port;
bogdanm 65:5798e58a58b1 87 };
bogdanm 65:5798e58a58b1 88
bogdanm 65:5798e58a58b1 89 } // namespace mbed
bogdanm 65:5798e58a58b1 90
bogdanm 65:5798e58a58b1 91 #endif
bogdanm 65:5798e58a58b1 92
bogdanm 65:5798e58a58b1 93 #endif