MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

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