MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/drivers/PortOut.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sahilmgandhi 18:6a4db94011d3 1 /* mbed Microcontroller Library
sahilmgandhi 18:6a4db94011d3 2 * Copyright (c) 2006-2013 ARM Limited
sahilmgandhi 18:6a4db94011d3 3 *
sahilmgandhi 18:6a4db94011d3 4 * Licensed under the Apache License, Version 2.0 (the "License");
sahilmgandhi 18:6a4db94011d3 5 * you may not use this file except in compliance with the License.
sahilmgandhi 18:6a4db94011d3 6 * You may obtain a copy of the License at
sahilmgandhi 18:6a4db94011d3 7 *
sahilmgandhi 18:6a4db94011d3 8 * http://www.apache.org/licenses/LICENSE-2.0
sahilmgandhi 18:6a4db94011d3 9 *
sahilmgandhi 18:6a4db94011d3 10 * Unless required by applicable law or agreed to in writing, software
sahilmgandhi 18:6a4db94011d3 11 * distributed under the License is distributed on an "AS IS" BASIS,
sahilmgandhi 18:6a4db94011d3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sahilmgandhi 18:6a4db94011d3 13 * See the License for the specific language governing permissions and
sahilmgandhi 18:6a4db94011d3 14 * limitations under the License.
sahilmgandhi 18:6a4db94011d3 15 */
sahilmgandhi 18:6a4db94011d3 16 #ifndef MBED_PORTOUT_H
sahilmgandhi 18:6a4db94011d3 17 #define MBED_PORTOUT_H
sahilmgandhi 18:6a4db94011d3 18
sahilmgandhi 18:6a4db94011d3 19 #include "platform/platform.h"
sahilmgandhi 18:6a4db94011d3 20
sahilmgandhi 18:6a4db94011d3 21 #if DEVICE_PORTOUT
sahilmgandhi 18:6a4db94011d3 22
sahilmgandhi 18:6a4db94011d3 23 #include "hal/port_api.h"
sahilmgandhi 18:6a4db94011d3 24 #include "platform/mbed_critical.h"
sahilmgandhi 18:6a4db94011d3 25
sahilmgandhi 18:6a4db94011d3 26 namespace mbed {
sahilmgandhi 18:6a4db94011d3 27 /** \addtogroup drivers */
sahilmgandhi 18:6a4db94011d3 28 /** @{*/
sahilmgandhi 18:6a4db94011d3 29 /** A multiple pin digital out
sahilmgandhi 18:6a4db94011d3 30 *
sahilmgandhi 18:6a4db94011d3 31 * @Note Synchronization level: Interrupt safe
sahilmgandhi 18:6a4db94011d3 32 *
sahilmgandhi 18:6a4db94011d3 33 * Example:
sahilmgandhi 18:6a4db94011d3 34 * @code
sahilmgandhi 18:6a4db94011d3 35 * // Toggle all four LEDs
sahilmgandhi 18:6a4db94011d3 36 *
sahilmgandhi 18:6a4db94011d3 37 * #include "mbed.h"
sahilmgandhi 18:6a4db94011d3 38 *
sahilmgandhi 18:6a4db94011d3 39 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
sahilmgandhi 18:6a4db94011d3 40 * #define LED_MASK 0x00B40000
sahilmgandhi 18:6a4db94011d3 41 *
sahilmgandhi 18:6a4db94011d3 42 * PortOut ledport(Port1, LED_MASK);
sahilmgandhi 18:6a4db94011d3 43 *
sahilmgandhi 18:6a4db94011d3 44 * int main() {
sahilmgandhi 18:6a4db94011d3 45 * while(1) {
sahilmgandhi 18:6a4db94011d3 46 * ledport = LED_MASK;
sahilmgandhi 18:6a4db94011d3 47 * wait(1);
sahilmgandhi 18:6a4db94011d3 48 * ledport = 0;
sahilmgandhi 18:6a4db94011d3 49 * wait(1);
sahilmgandhi 18:6a4db94011d3 50 * }
sahilmgandhi 18:6a4db94011d3 51 * }
sahilmgandhi 18:6a4db94011d3 52 * @endcode
sahilmgandhi 18:6a4db94011d3 53 */
sahilmgandhi 18:6a4db94011d3 54 class PortOut {
sahilmgandhi 18:6a4db94011d3 55 public:
sahilmgandhi 18:6a4db94011d3 56
sahilmgandhi 18:6a4db94011d3 57 /** Create an PortOut, connected to the specified port
sahilmgandhi 18:6a4db94011d3 58 *
sahilmgandhi 18:6a4db94011d3 59 * @param port Port to connect to (Port0-Port5)
sahilmgandhi 18:6a4db94011d3 60 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
sahilmgandhi 18:6a4db94011d3 61 */
sahilmgandhi 18:6a4db94011d3 62 PortOut(PortName port, int mask = 0xFFFFFFFF) {
sahilmgandhi 18:6a4db94011d3 63 core_util_critical_section_enter();
sahilmgandhi 18:6a4db94011d3 64 port_init(&_port, port, mask, PIN_OUTPUT);
sahilmgandhi 18:6a4db94011d3 65 core_util_critical_section_exit();
sahilmgandhi 18:6a4db94011d3 66 }
sahilmgandhi 18:6a4db94011d3 67
sahilmgandhi 18:6a4db94011d3 68 /** Write the value to the output port
sahilmgandhi 18:6a4db94011d3 69 *
sahilmgandhi 18:6a4db94011d3 70 * @param value An integer specifying a bit to write for every corresponding PortOut pin
sahilmgandhi 18:6a4db94011d3 71 */
sahilmgandhi 18:6a4db94011d3 72 void write(int value) {
sahilmgandhi 18:6a4db94011d3 73 port_write(&_port, value);
sahilmgandhi 18:6a4db94011d3 74 }
sahilmgandhi 18:6a4db94011d3 75
sahilmgandhi 18:6a4db94011d3 76 /** Read the value currently output on the port
sahilmgandhi 18:6a4db94011d3 77 *
sahilmgandhi 18:6a4db94011d3 78 * @returns
sahilmgandhi 18:6a4db94011d3 79 * An integer with each bit corresponding to associated PortOut pin setting
sahilmgandhi 18:6a4db94011d3 80 */
sahilmgandhi 18:6a4db94011d3 81 int read() {
sahilmgandhi 18:6a4db94011d3 82 return port_read(&_port);
sahilmgandhi 18:6a4db94011d3 83 }
sahilmgandhi 18:6a4db94011d3 84
sahilmgandhi 18:6a4db94011d3 85 /** A shorthand for write()
sahilmgandhi 18:6a4db94011d3 86 */
sahilmgandhi 18:6a4db94011d3 87 PortOut& operator= (int value) {
sahilmgandhi 18:6a4db94011d3 88 write(value);
sahilmgandhi 18:6a4db94011d3 89 return *this;
sahilmgandhi 18:6a4db94011d3 90 }
sahilmgandhi 18:6a4db94011d3 91
sahilmgandhi 18:6a4db94011d3 92 PortOut& operator= (PortOut& rhs) {
sahilmgandhi 18:6a4db94011d3 93 write(rhs.read());
sahilmgandhi 18:6a4db94011d3 94 return *this;
sahilmgandhi 18:6a4db94011d3 95 }
sahilmgandhi 18:6a4db94011d3 96
sahilmgandhi 18:6a4db94011d3 97 /** A shorthand for read()
sahilmgandhi 18:6a4db94011d3 98 */
sahilmgandhi 18:6a4db94011d3 99 operator int() {
sahilmgandhi 18:6a4db94011d3 100 return read();
sahilmgandhi 18:6a4db94011d3 101 }
sahilmgandhi 18:6a4db94011d3 102
sahilmgandhi 18:6a4db94011d3 103 private:
sahilmgandhi 18:6a4db94011d3 104 port_t _port;
sahilmgandhi 18:6a4db94011d3 105 };
sahilmgandhi 18:6a4db94011d3 106
sahilmgandhi 18:6a4db94011d3 107 } // namespace mbed
sahilmgandhi 18:6a4db94011d3 108
sahilmgandhi 18:6a4db94011d3 109 #endif
sahilmgandhi 18:6a4db94011d3 110
sahilmgandhi 18:6a4db94011d3 111 #endif
sahilmgandhi 18:6a4db94011d3 112
sahilmgandhi 18:6a4db94011d3 113 /** @}*/