Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

PortIn.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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