MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/drivers/DigitalInOut.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_DIGITALINOUT_H
sahilmgandhi 18:6a4db94011d3 17 #define MBED_DIGITALINOUT_H
sahilmgandhi 18:6a4db94011d3 18
sahilmgandhi 18:6a4db94011d3 19 #include "platform/platform.h"
sahilmgandhi 18:6a4db94011d3 20
sahilmgandhi 18:6a4db94011d3 21 #include "hal/gpio_api.h"
sahilmgandhi 18:6a4db94011d3 22 #include "platform/mbed_critical.h"
sahilmgandhi 18:6a4db94011d3 23
sahilmgandhi 18:6a4db94011d3 24 namespace mbed {
sahilmgandhi 18:6a4db94011d3 25 /** \addtogroup drivers */
sahilmgandhi 18:6a4db94011d3 26 /** @{*/
sahilmgandhi 18:6a4db94011d3 27
sahilmgandhi 18:6a4db94011d3 28 /** A digital input/output, used for setting or reading a bi-directional pin
sahilmgandhi 18:6a4db94011d3 29 *
sahilmgandhi 18:6a4db94011d3 30 * @Note Synchronization level: Interrupt safe
sahilmgandhi 18:6a4db94011d3 31 */
sahilmgandhi 18:6a4db94011d3 32 class DigitalInOut {
sahilmgandhi 18:6a4db94011d3 33
sahilmgandhi 18:6a4db94011d3 34 public:
sahilmgandhi 18:6a4db94011d3 35 /** Create a DigitalInOut connected to the specified pin
sahilmgandhi 18:6a4db94011d3 36 *
sahilmgandhi 18:6a4db94011d3 37 * @param pin DigitalInOut pin to connect to
sahilmgandhi 18:6a4db94011d3 38 */
sahilmgandhi 18:6a4db94011d3 39 DigitalInOut(PinName pin) : gpio() {
sahilmgandhi 18:6a4db94011d3 40 // No lock needed in the constructor
sahilmgandhi 18:6a4db94011d3 41 gpio_init_in(&gpio, pin);
sahilmgandhi 18:6a4db94011d3 42 }
sahilmgandhi 18:6a4db94011d3 43
sahilmgandhi 18:6a4db94011d3 44 /** Create a DigitalInOut connected to the specified pin
sahilmgandhi 18:6a4db94011d3 45 *
sahilmgandhi 18:6a4db94011d3 46 * @param pin DigitalInOut pin to connect to
sahilmgandhi 18:6a4db94011d3 47 * @param direction the initial direction of the pin
sahilmgandhi 18:6a4db94011d3 48 * @param mode the initial mode of the pin
sahilmgandhi 18:6a4db94011d3 49 * @param value the initial value of the pin if is an output
sahilmgandhi 18:6a4db94011d3 50 */
sahilmgandhi 18:6a4db94011d3 51 DigitalInOut(PinName pin, PinDirection direction, PinMode mode, int value) : gpio() {
sahilmgandhi 18:6a4db94011d3 52 // No lock needed in the constructor
sahilmgandhi 18:6a4db94011d3 53 gpio_init_inout(&gpio, pin, direction, mode, value);
sahilmgandhi 18:6a4db94011d3 54 }
sahilmgandhi 18:6a4db94011d3 55
sahilmgandhi 18:6a4db94011d3 56 /** Set the output, specified as 0 or 1 (int)
sahilmgandhi 18:6a4db94011d3 57 *
sahilmgandhi 18:6a4db94011d3 58 * @param value An integer specifying the pin output value,
sahilmgandhi 18:6a4db94011d3 59 * 0 for logical 0, 1 (or any other non-zero value) for logical 1
sahilmgandhi 18:6a4db94011d3 60 */
sahilmgandhi 18:6a4db94011d3 61 void write(int value) {
sahilmgandhi 18:6a4db94011d3 62 // Thread safe / atomic HAL call
sahilmgandhi 18:6a4db94011d3 63 gpio_write(&gpio, value);
sahilmgandhi 18:6a4db94011d3 64 }
sahilmgandhi 18:6a4db94011d3 65
sahilmgandhi 18:6a4db94011d3 66 /** Return the output setting, represented as 0 or 1 (int)
sahilmgandhi 18:6a4db94011d3 67 *
sahilmgandhi 18:6a4db94011d3 68 * @returns
sahilmgandhi 18:6a4db94011d3 69 * an integer representing the output setting of the pin if it is an output,
sahilmgandhi 18:6a4db94011d3 70 * or read the input if set as an input
sahilmgandhi 18:6a4db94011d3 71 */
sahilmgandhi 18:6a4db94011d3 72 int read() {
sahilmgandhi 18:6a4db94011d3 73 // Thread safe / atomic HAL call
sahilmgandhi 18:6a4db94011d3 74 return gpio_read(&gpio);
sahilmgandhi 18:6a4db94011d3 75 }
sahilmgandhi 18:6a4db94011d3 76
sahilmgandhi 18:6a4db94011d3 77 /** Set as an output
sahilmgandhi 18:6a4db94011d3 78 */
sahilmgandhi 18:6a4db94011d3 79 void output() {
sahilmgandhi 18:6a4db94011d3 80 core_util_critical_section_enter();
sahilmgandhi 18:6a4db94011d3 81 gpio_dir(&gpio, PIN_OUTPUT);
sahilmgandhi 18:6a4db94011d3 82 core_util_critical_section_exit();
sahilmgandhi 18:6a4db94011d3 83 }
sahilmgandhi 18:6a4db94011d3 84
sahilmgandhi 18:6a4db94011d3 85 /** Set as an input
sahilmgandhi 18:6a4db94011d3 86 */
sahilmgandhi 18:6a4db94011d3 87 void input() {
sahilmgandhi 18:6a4db94011d3 88 core_util_critical_section_enter();
sahilmgandhi 18:6a4db94011d3 89 gpio_dir(&gpio, PIN_INPUT);
sahilmgandhi 18:6a4db94011d3 90 core_util_critical_section_exit();
sahilmgandhi 18:6a4db94011d3 91 }
sahilmgandhi 18:6a4db94011d3 92
sahilmgandhi 18:6a4db94011d3 93 /** Set the input pin mode
sahilmgandhi 18:6a4db94011d3 94 *
sahilmgandhi 18:6a4db94011d3 95 * @param mode PullUp, PullDown, PullNone, OpenDrain
sahilmgandhi 18:6a4db94011d3 96 */
sahilmgandhi 18:6a4db94011d3 97 void mode(PinMode pull) {
sahilmgandhi 18:6a4db94011d3 98 core_util_critical_section_enter();
sahilmgandhi 18:6a4db94011d3 99 gpio_mode(&gpio, pull);
sahilmgandhi 18:6a4db94011d3 100 core_util_critical_section_exit();
sahilmgandhi 18:6a4db94011d3 101 }
sahilmgandhi 18:6a4db94011d3 102
sahilmgandhi 18:6a4db94011d3 103 /** Return the output setting, represented as 0 or 1 (int)
sahilmgandhi 18:6a4db94011d3 104 *
sahilmgandhi 18:6a4db94011d3 105 * @returns
sahilmgandhi 18:6a4db94011d3 106 * Non zero value if pin is connected to uc GPIO
sahilmgandhi 18:6a4db94011d3 107 * 0 if gpio object was initialized with NC
sahilmgandhi 18:6a4db94011d3 108 */
sahilmgandhi 18:6a4db94011d3 109 int is_connected() {
sahilmgandhi 18:6a4db94011d3 110 // Thread safe / atomic HAL call
sahilmgandhi 18:6a4db94011d3 111 return gpio_is_connected(&gpio);
sahilmgandhi 18:6a4db94011d3 112 }
sahilmgandhi 18:6a4db94011d3 113
sahilmgandhi 18:6a4db94011d3 114 /** A shorthand for write()
sahilmgandhi 18:6a4db94011d3 115 */
sahilmgandhi 18:6a4db94011d3 116 DigitalInOut& operator= (int value) {
sahilmgandhi 18:6a4db94011d3 117 // Underlying write is thread safe
sahilmgandhi 18:6a4db94011d3 118 write(value);
sahilmgandhi 18:6a4db94011d3 119 return *this;
sahilmgandhi 18:6a4db94011d3 120 }
sahilmgandhi 18:6a4db94011d3 121
sahilmgandhi 18:6a4db94011d3 122 DigitalInOut& operator= (DigitalInOut& rhs) {
sahilmgandhi 18:6a4db94011d3 123 core_util_critical_section_enter();
sahilmgandhi 18:6a4db94011d3 124 write(rhs.read());
sahilmgandhi 18:6a4db94011d3 125 core_util_critical_section_exit();
sahilmgandhi 18:6a4db94011d3 126 return *this;
sahilmgandhi 18:6a4db94011d3 127 }
sahilmgandhi 18:6a4db94011d3 128
sahilmgandhi 18:6a4db94011d3 129 /** A shorthand for read()
sahilmgandhi 18:6a4db94011d3 130 */
sahilmgandhi 18:6a4db94011d3 131 operator int() {
sahilmgandhi 18:6a4db94011d3 132 // Underlying call is thread safe
sahilmgandhi 18:6a4db94011d3 133 return read();
sahilmgandhi 18:6a4db94011d3 134 }
sahilmgandhi 18:6a4db94011d3 135
sahilmgandhi 18:6a4db94011d3 136 protected:
sahilmgandhi 18:6a4db94011d3 137 gpio_t gpio;
sahilmgandhi 18:6a4db94011d3 138 };
sahilmgandhi 18:6a4db94011d3 139
sahilmgandhi 18:6a4db94011d3 140 } // namespace mbed
sahilmgandhi 18:6a4db94011d3 141
sahilmgandhi 18:6a4db94011d3 142 #endif
sahilmgandhi 18:6a4db94011d3 143
sahilmgandhi 18:6a4db94011d3 144 /** @}*/