spinal cord / PokittoLib_

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

mbed-pokitto/api/PortOut.h@64:6e6c6c2b664e, 2018-11-18 (annotated)

Committer:
spinal
Date:
Sun Nov 18 15:47:54 2018 +0000
Revision:
64:6e6c6c2b664e
Parent:
5:ea7377f3d1af 
added fix for directrectangle()

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_PORTOUT_H
Pokitto 5:ea7377f3d1af 17 #define MBED_PORTOUT_H
Pokitto 5:ea7377f3d1af 18
Pokitto 5:ea7377f3d1af 19 #include "platform.h"
Pokitto 5:ea7377f3d1af 20
Pokitto 5:ea7377f3d1af 21 #if DEVICE_PORTOUT
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 /** A multiple pin digital out
Pokitto 5:ea7377f3d1af 27 *
Pokitto 5:ea7377f3d1af 28 * Example:
Pokitto 5:ea7377f3d1af 29 * @code
Pokitto 5:ea7377f3d1af 30 * // Toggle all four LEDs
Pokitto 5:ea7377f3d1af 31 *
Pokitto 5:ea7377f3d1af 32 * #include "mbed.h"
Pokitto 5:ea7377f3d1af 33 *
Pokitto 5:ea7377f3d1af 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
Pokitto 5:ea7377f3d1af 35 * #define LED_MASK 0x00B40000
Pokitto 5:ea7377f3d1af 36 *
Pokitto 5:ea7377f3d1af 37 * PortOut ledport(Port1, LED_MASK);
Pokitto 5:ea7377f3d1af 38 *
Pokitto 5:ea7377f3d1af 39 * int main() {
Pokitto 5:ea7377f3d1af 40 * while(1) {
Pokitto 5:ea7377f3d1af 41 * ledport = LED_MASK;
Pokitto 5:ea7377f3d1af 42 * wait(1);
Pokitto 5:ea7377f3d1af 43 * ledport = 0;
Pokitto 5:ea7377f3d1af 44 * wait(1);
Pokitto 5:ea7377f3d1af 45 * }
Pokitto 5:ea7377f3d1af 46 * }
Pokitto 5:ea7377f3d1af 47 * @endcode
Pokitto 5:ea7377f3d1af 48 */
Pokitto 5:ea7377f3d1af 49 class PortOut {
Pokitto 5:ea7377f3d1af 50 public:
Pokitto 5:ea7377f3d1af 51
Pokitto 5:ea7377f3d1af 52 /** Create an PortOut, connected to the specified port
Pokitto 5:ea7377f3d1af 53 *
Pokitto 5:ea7377f3d1af 54 * @param port Port to connect to (Port0-Port5)
Pokitto 5:ea7377f3d1af 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
Pokitto 5:ea7377f3d1af 56 */
Pokitto 5:ea7377f3d1af 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
Pokitto 5:ea7377f3d1af 58 port_init(&_port, port, mask, PIN_OUTPUT);
Pokitto 5:ea7377f3d1af 59 }
Pokitto 5:ea7377f3d1af 60
Pokitto 5:ea7377f3d1af 61 /** Write the value to the output port
Pokitto 5:ea7377f3d1af 62 *
Pokitto 5:ea7377f3d1af 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
Pokitto 5:ea7377f3d1af 64 */
Pokitto 5:ea7377f3d1af 65 void write(int value) {
Pokitto 5:ea7377f3d1af 66 port_write(&_port, value);
Pokitto 5:ea7377f3d1af 67 }
Pokitto 5:ea7377f3d1af 68
Pokitto 5:ea7377f3d1af 69 /** Read the value currently output on the port
Pokitto 5:ea7377f3d1af 70 *
Pokitto 5:ea7377f3d1af 71 * @returns
Pokitto 5:ea7377f3d1af 72 * An integer with each bit corresponding to associated PortOut pin setting
Pokitto 5:ea7377f3d1af 73 */
Pokitto 5:ea7377f3d1af 74 int read() {
Pokitto 5:ea7377f3d1af 75 return port_read(&_port);
Pokitto 5:ea7377f3d1af 76 }
Pokitto 5:ea7377f3d1af 77
Pokitto 5:ea7377f3d1af 78 /** A shorthand for write()
Pokitto 5:ea7377f3d1af 79 */
Pokitto 5:ea7377f3d1af 80 PortOut& operator= (int value) {
Pokitto 5:ea7377f3d1af 81 write(value);
Pokitto 5:ea7377f3d1af 82 return *this;
Pokitto 5:ea7377f3d1af 83 }
Pokitto 5:ea7377f3d1af 84
Pokitto 5:ea7377f3d1af 85 PortOut& operator= (PortOut& rhs) {
Pokitto 5:ea7377f3d1af 86 write(rhs.read());
Pokitto 5:ea7377f3d1af 87 return *this;
Pokitto 5:ea7377f3d1af 88 }
Pokitto 5:ea7377f3d1af 89
Pokitto 5:ea7377f3d1af 90 /** A shorthand for read()
Pokitto 5:ea7377f3d1af 91 */
Pokitto 5:ea7377f3d1af 92 operator int() {
Pokitto 5:ea7377f3d1af 93 return read();
Pokitto 5:ea7377f3d1af 94 }
Pokitto 5:ea7377f3d1af 95
Pokitto 5:ea7377f3d1af 96 private:
Pokitto 5:ea7377f3d1af 97 port_t _port;
Pokitto 5:ea7377f3d1af 98 };
Pokitto 5:ea7377f3d1af 99
Pokitto 5:ea7377f3d1af 100 } // namespace mbed
Pokitto 5:ea7377f3d1af 101
Pokitto 5:ea7377f3d1af 102 #endif
Pokitto 5:ea7377f3d1af 103
Pokitto 5:ea7377f3d1af 104 #endif