MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/drivers/Ethernet.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_ETHERNET_H
sahilmgandhi 18:6a4db94011d3 17 #define MBED_ETHERNET_H
sahilmgandhi 18:6a4db94011d3 18
sahilmgandhi 18:6a4db94011d3 19 #include "platform/platform.h"
sahilmgandhi 18:6a4db94011d3 20
sahilmgandhi 18:6a4db94011d3 21 #if DEVICE_ETHERNET
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 /** An ethernet interface, to use with the ethernet pins.
sahilmgandhi 18:6a4db94011d3 28 *
sahilmgandhi 18:6a4db94011d3 29 * @Note Synchronization level: Not protected
sahilmgandhi 18:6a4db94011d3 30 *
sahilmgandhi 18:6a4db94011d3 31 * Example:
sahilmgandhi 18:6a4db94011d3 32 * @code
sahilmgandhi 18:6a4db94011d3 33 * // Read destination and source from every ethernet packet
sahilmgandhi 18:6a4db94011d3 34 *
sahilmgandhi 18:6a4db94011d3 35 * #include "mbed.h"
sahilmgandhi 18:6a4db94011d3 36 *
sahilmgandhi 18:6a4db94011d3 37 * Ethernet eth;
sahilmgandhi 18:6a4db94011d3 38 *
sahilmgandhi 18:6a4db94011d3 39 * int main() {
sahilmgandhi 18:6a4db94011d3 40 * char buf[0x600];
sahilmgandhi 18:6a4db94011d3 41 *
sahilmgandhi 18:6a4db94011d3 42 * while(1) {
sahilmgandhi 18:6a4db94011d3 43 * int size = eth.receive();
sahilmgandhi 18:6a4db94011d3 44 * if(size > 0) {
sahilmgandhi 18:6a4db94011d3 45 * eth.read(buf, size);
sahilmgandhi 18:6a4db94011d3 46 * printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
sahilmgandhi 18:6a4db94011d3 47 * buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
sahilmgandhi 18:6a4db94011d3 48 * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
sahilmgandhi 18:6a4db94011d3 49 * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
sahilmgandhi 18:6a4db94011d3 50 * }
sahilmgandhi 18:6a4db94011d3 51 *
sahilmgandhi 18:6a4db94011d3 52 * wait(1);
sahilmgandhi 18:6a4db94011d3 53 * }
sahilmgandhi 18:6a4db94011d3 54 * }
sahilmgandhi 18:6a4db94011d3 55 * @endcode
sahilmgandhi 18:6a4db94011d3 56 */
sahilmgandhi 18:6a4db94011d3 57 class Ethernet {
sahilmgandhi 18:6a4db94011d3 58
sahilmgandhi 18:6a4db94011d3 59 public:
sahilmgandhi 18:6a4db94011d3 60
sahilmgandhi 18:6a4db94011d3 61 /** Initialise the ethernet interface.
sahilmgandhi 18:6a4db94011d3 62 */
sahilmgandhi 18:6a4db94011d3 63 Ethernet();
sahilmgandhi 18:6a4db94011d3 64
sahilmgandhi 18:6a4db94011d3 65 /** Powers the hardware down.
sahilmgandhi 18:6a4db94011d3 66 */
sahilmgandhi 18:6a4db94011d3 67 virtual ~Ethernet();
sahilmgandhi 18:6a4db94011d3 68
sahilmgandhi 18:6a4db94011d3 69 enum Mode {
sahilmgandhi 18:6a4db94011d3 70 AutoNegotiate,
sahilmgandhi 18:6a4db94011d3 71 HalfDuplex10,
sahilmgandhi 18:6a4db94011d3 72 FullDuplex10,
sahilmgandhi 18:6a4db94011d3 73 HalfDuplex100,
sahilmgandhi 18:6a4db94011d3 74 FullDuplex100
sahilmgandhi 18:6a4db94011d3 75 };
sahilmgandhi 18:6a4db94011d3 76
sahilmgandhi 18:6a4db94011d3 77 /** Writes into an outgoing ethernet packet.
sahilmgandhi 18:6a4db94011d3 78 *
sahilmgandhi 18:6a4db94011d3 79 * It will append size bytes of data to the previously written bytes.
sahilmgandhi 18:6a4db94011d3 80 *
sahilmgandhi 18:6a4db94011d3 81 * @param data An array to write.
sahilmgandhi 18:6a4db94011d3 82 * @param size The size of data.
sahilmgandhi 18:6a4db94011d3 83 *
sahilmgandhi 18:6a4db94011d3 84 * @returns
sahilmgandhi 18:6a4db94011d3 85 * The number of written bytes.
sahilmgandhi 18:6a4db94011d3 86 */
sahilmgandhi 18:6a4db94011d3 87 int write(const char *data, int size);
sahilmgandhi 18:6a4db94011d3 88
sahilmgandhi 18:6a4db94011d3 89 /** Send an outgoing ethernet packet.
sahilmgandhi 18:6a4db94011d3 90 *
sahilmgandhi 18:6a4db94011d3 91 * After filling in the data in an ethernet packet it must be send.
sahilmgandhi 18:6a4db94011d3 92 * Send will provide a new packet to write to.
sahilmgandhi 18:6a4db94011d3 93 *
sahilmgandhi 18:6a4db94011d3 94 * @returns
sahilmgandhi 18:6a4db94011d3 95 * 0 if the sending was failed,
sahilmgandhi 18:6a4db94011d3 96 * or the size of the packet successfully sent.
sahilmgandhi 18:6a4db94011d3 97 */
sahilmgandhi 18:6a4db94011d3 98 int send();
sahilmgandhi 18:6a4db94011d3 99
sahilmgandhi 18:6a4db94011d3 100 /** Recevies an arrived ethernet packet.
sahilmgandhi 18:6a4db94011d3 101 *
sahilmgandhi 18:6a4db94011d3 102 * Receiving an ethernet packet will drop the last received ethernet packet
sahilmgandhi 18:6a4db94011d3 103 * and make a new ethernet packet ready to read.
sahilmgandhi 18:6a4db94011d3 104 * If no ethernet packet is arrived it will return 0.
sahilmgandhi 18:6a4db94011d3 105 *
sahilmgandhi 18:6a4db94011d3 106 * @returns
sahilmgandhi 18:6a4db94011d3 107 * 0 if no ethernet packet is arrived,
sahilmgandhi 18:6a4db94011d3 108 * or the size of the arrived packet.
sahilmgandhi 18:6a4db94011d3 109 */
sahilmgandhi 18:6a4db94011d3 110 int receive();
sahilmgandhi 18:6a4db94011d3 111
sahilmgandhi 18:6a4db94011d3 112 /** Read from an recevied ethernet packet.
sahilmgandhi 18:6a4db94011d3 113 *
sahilmgandhi 18:6a4db94011d3 114 * After receive returnd a number bigger than 0it is
sahilmgandhi 18:6a4db94011d3 115 * possible to read bytes from this packet.
sahilmgandhi 18:6a4db94011d3 116 * Read will write up to size bytes into data.
sahilmgandhi 18:6a4db94011d3 117 *
sahilmgandhi 18:6a4db94011d3 118 * It is possible to use read multible times.
sahilmgandhi 18:6a4db94011d3 119 * Each time read will start reading after the last read byte before.
sahilmgandhi 18:6a4db94011d3 120 *
sahilmgandhi 18:6a4db94011d3 121 * @returns
sahilmgandhi 18:6a4db94011d3 122 * The number of byte read.
sahilmgandhi 18:6a4db94011d3 123 */
sahilmgandhi 18:6a4db94011d3 124 int read(char *data, int size);
sahilmgandhi 18:6a4db94011d3 125
sahilmgandhi 18:6a4db94011d3 126 /** Gives the ethernet address of the mbed.
sahilmgandhi 18:6a4db94011d3 127 *
sahilmgandhi 18:6a4db94011d3 128 * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
sahilmgandhi 18:6a4db94011d3 129 */
sahilmgandhi 18:6a4db94011d3 130 void address(char *mac);
sahilmgandhi 18:6a4db94011d3 131
sahilmgandhi 18:6a4db94011d3 132 /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up.
sahilmgandhi 18:6a4db94011d3 133 *
sahilmgandhi 18:6a4db94011d3 134 * @returns
sahilmgandhi 18:6a4db94011d3 135 * 0 if no ethernet link is pressent,
sahilmgandhi 18:6a4db94011d3 136 * 1 if an ethernet link is pressent.
sahilmgandhi 18:6a4db94011d3 137 *
sahilmgandhi 18:6a4db94011d3 138 * Example:
sahilmgandhi 18:6a4db94011d3 139 * @code
sahilmgandhi 18:6a4db94011d3 140 * // Using the Ethernet link function
sahilmgandhi 18:6a4db94011d3 141 * #include "mbed.h"
sahilmgandhi 18:6a4db94011d3 142 *
sahilmgandhi 18:6a4db94011d3 143 * Ethernet eth;
sahilmgandhi 18:6a4db94011d3 144 *
sahilmgandhi 18:6a4db94011d3 145 * int main() {
sahilmgandhi 18:6a4db94011d3 146 * wait(1); // Needed after startup.
sahilmgandhi 18:6a4db94011d3 147 * if (eth.link()) {
sahilmgandhi 18:6a4db94011d3 148 * printf("online\n");
sahilmgandhi 18:6a4db94011d3 149 * } else {
sahilmgandhi 18:6a4db94011d3 150 * printf("offline\n");
sahilmgandhi 18:6a4db94011d3 151 * }
sahilmgandhi 18:6a4db94011d3 152 * }
sahilmgandhi 18:6a4db94011d3 153 * @endcode
sahilmgandhi 18:6a4db94011d3 154 */
sahilmgandhi 18:6a4db94011d3 155 int link();
sahilmgandhi 18:6a4db94011d3 156
sahilmgandhi 18:6a4db94011d3 157 /** Sets the speed and duplex parameters of an ethernet link
sahilmgandhi 18:6a4db94011d3 158 *
sahilmgandhi 18:6a4db94011d3 159 * - AutoNegotiate Auto negotiate speed and duplex
sahilmgandhi 18:6a4db94011d3 160 * - HalfDuplex10 10 Mbit, half duplex
sahilmgandhi 18:6a4db94011d3 161 * - FullDuplex10 10 Mbit, full duplex
sahilmgandhi 18:6a4db94011d3 162 * - HalfDuplex100 100 Mbit, half duplex
sahilmgandhi 18:6a4db94011d3 163 * - FullDuplex100 100 Mbit, full duplex
sahilmgandhi 18:6a4db94011d3 164 *
sahilmgandhi 18:6a4db94011d3 165 * @param mode the speed and duplex mode to set the link to:
sahilmgandhi 18:6a4db94011d3 166 */
sahilmgandhi 18:6a4db94011d3 167 void set_link(Mode mode);
sahilmgandhi 18:6a4db94011d3 168 };
sahilmgandhi 18:6a4db94011d3 169
sahilmgandhi 18:6a4db94011d3 170 } // namespace mbed
sahilmgandhi 18:6a4db94011d3 171
sahilmgandhi 18:6a4db94011d3 172 #endif
sahilmgandhi 18:6a4db94011d3 173
sahilmgandhi 18:6a4db94011d3 174 #endif
sahilmgandhi 18:6a4db94011d3 175
sahilmgandhi 18:6a4db94011d3 176 /** @}*/