Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

PortInOut.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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