Juan Salazar / mbed

test

Dependents:   robotic_fish_7

PortIn.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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