spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/PortIn.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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