Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/Ethernet.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

Who changed what in which revision?

UserRevisionLine numberNew contents of line
aravindsv 0:ba7650f404af 1 /* mbed Microcontroller Library
aravindsv 0:ba7650f404af 2 * Copyright (c) 2006-2013 ARM Limited
aravindsv 0:ba7650f404af 3 *
aravindsv 0:ba7650f404af 4 * Licensed under the Apache License, Version 2.0 (the "License");
aravindsv 0:ba7650f404af 5 * you may not use this file except in compliance with the License.
aravindsv 0:ba7650f404af 6 * You may obtain a copy of the License at
aravindsv 0:ba7650f404af 7 *
aravindsv 0:ba7650f404af 8 * http://www.apache.org/licenses/LICENSE-2.0
aravindsv 0:ba7650f404af 9 *
aravindsv 0:ba7650f404af 10 * Unless required by applicable law or agreed to in writing, software
aravindsv 0:ba7650f404af 11 * distributed under the License is distributed on an "AS IS" BASIS,
aravindsv 0:ba7650f404af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
aravindsv 0:ba7650f404af 13 * See the License for the specific language governing permissions and
aravindsv 0:ba7650f404af 14 * limitations under the License.
aravindsv 0:ba7650f404af 15 */
aravindsv 0:ba7650f404af 16 #ifndef MBED_ETHERNET_H
aravindsv 0:ba7650f404af 17 #define MBED_ETHERNET_H
aravindsv 0:ba7650f404af 18
aravindsv 0:ba7650f404af 19 #include "platform.h"
aravindsv 0:ba7650f404af 20
aravindsv 0:ba7650f404af 21 #if DEVICE_ETHERNET
aravindsv 0:ba7650f404af 22
aravindsv 0:ba7650f404af 23 namespace mbed {
aravindsv 0:ba7650f404af 24
aravindsv 0:ba7650f404af 25 /** An ethernet interface, to use with the ethernet pins.
aravindsv 0:ba7650f404af 26 *
aravindsv 0:ba7650f404af 27 * Example:
aravindsv 0:ba7650f404af 28 * @code
aravindsv 0:ba7650f404af 29 * // Read destination and source from every ethernet packet
aravindsv 0:ba7650f404af 30 *
aravindsv 0:ba7650f404af 31 * #include "mbed.h"
aravindsv 0:ba7650f404af 32 *
aravindsv 0:ba7650f404af 33 * Ethernet eth;
aravindsv 0:ba7650f404af 34 *
aravindsv 0:ba7650f404af 35 * int main() {
aravindsv 0:ba7650f404af 36 * char buf[0x600];
aravindsv 0:ba7650f404af 37 *
aravindsv 0:ba7650f404af 38 * while(1) {
aravindsv 0:ba7650f404af 39 * int size = eth.receive();
aravindsv 0:ba7650f404af 40 * if(size > 0) {
aravindsv 0:ba7650f404af 41 * eth.read(buf, size);
aravindsv 0:ba7650f404af 42 * printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
aravindsv 0:ba7650f404af 43 * buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
aravindsv 0:ba7650f404af 44 * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
aravindsv 0:ba7650f404af 45 * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
aravindsv 0:ba7650f404af 46 * }
aravindsv 0:ba7650f404af 47 *
aravindsv 0:ba7650f404af 48 * wait(1);
aravindsv 0:ba7650f404af 49 * }
aravindsv 0:ba7650f404af 50 * }
aravindsv 0:ba7650f404af 51 * @endcode
aravindsv 0:ba7650f404af 52 */
aravindsv 0:ba7650f404af 53 class Ethernet {
aravindsv 0:ba7650f404af 54
aravindsv 0:ba7650f404af 55 public:
aravindsv 0:ba7650f404af 56
aravindsv 0:ba7650f404af 57 /** Initialise the ethernet interface.
aravindsv 0:ba7650f404af 58 */
aravindsv 0:ba7650f404af 59 Ethernet();
aravindsv 0:ba7650f404af 60
aravindsv 0:ba7650f404af 61 /** Powers the hardware down.
aravindsv 0:ba7650f404af 62 */
aravindsv 0:ba7650f404af 63 virtual ~Ethernet();
aravindsv 0:ba7650f404af 64
aravindsv 0:ba7650f404af 65 enum Mode {
aravindsv 0:ba7650f404af 66 AutoNegotiate,
aravindsv 0:ba7650f404af 67 HalfDuplex10,
aravindsv 0:ba7650f404af 68 FullDuplex10,
aravindsv 0:ba7650f404af 69 HalfDuplex100,
aravindsv 0:ba7650f404af 70 FullDuplex100
aravindsv 0:ba7650f404af 71 };
aravindsv 0:ba7650f404af 72
aravindsv 0:ba7650f404af 73 /** Writes into an outgoing ethernet packet.
aravindsv 0:ba7650f404af 74 *
aravindsv 0:ba7650f404af 75 * It will append size bytes of data to the previously written bytes.
aravindsv 0:ba7650f404af 76 *
aravindsv 0:ba7650f404af 77 * @param data An array to write.
aravindsv 0:ba7650f404af 78 * @param size The size of data.
aravindsv 0:ba7650f404af 79 *
aravindsv 0:ba7650f404af 80 * @returns
aravindsv 0:ba7650f404af 81 * The number of written bytes.
aravindsv 0:ba7650f404af 82 */
aravindsv 0:ba7650f404af 83 int write(const char *data, int size);
aravindsv 0:ba7650f404af 84
aravindsv 0:ba7650f404af 85 /** Send an outgoing ethernet packet.
aravindsv 0:ba7650f404af 86 *
aravindsv 0:ba7650f404af 87 * After filling in the data in an ethernet packet it must be send.
aravindsv 0:ba7650f404af 88 * Send will provide a new packet to write to.
aravindsv 0:ba7650f404af 89 *
aravindsv 0:ba7650f404af 90 * @returns
aravindsv 0:ba7650f404af 91 * 0 if the sending was failed,
aravindsv 0:ba7650f404af 92 * or the size of the packet successfully sent.
aravindsv 0:ba7650f404af 93 */
aravindsv 0:ba7650f404af 94 int send();
aravindsv 0:ba7650f404af 95
aravindsv 0:ba7650f404af 96 /** Recevies an arrived ethernet packet.
aravindsv 0:ba7650f404af 97 *
aravindsv 0:ba7650f404af 98 * Receiving an ethernet packet will drop the last received ethernet packet
aravindsv 0:ba7650f404af 99 * and make a new ethernet packet ready to read.
aravindsv 0:ba7650f404af 100 * If no ethernet packet is arrived it will return 0.
aravindsv 0:ba7650f404af 101 *
aravindsv 0:ba7650f404af 102 * @returns
aravindsv 0:ba7650f404af 103 * 0 if no ethernet packet is arrived,
aravindsv 0:ba7650f404af 104 * or the size of the arrived packet.
aravindsv 0:ba7650f404af 105 */
aravindsv 0:ba7650f404af 106 int receive();
aravindsv 0:ba7650f404af 107
aravindsv 0:ba7650f404af 108 /** Read from an recevied ethernet packet.
aravindsv 0:ba7650f404af 109 *
aravindsv 0:ba7650f404af 110 * After receive returnd a number bigger than 0it is
aravindsv 0:ba7650f404af 111 * possible to read bytes from this packet.
aravindsv 0:ba7650f404af 112 * Read will write up to size bytes into data.
aravindsv 0:ba7650f404af 113 *
aravindsv 0:ba7650f404af 114 * It is possible to use read multible times.
aravindsv 0:ba7650f404af 115 * Each time read will start reading after the last read byte before.
aravindsv 0:ba7650f404af 116 *
aravindsv 0:ba7650f404af 117 * @returns
aravindsv 0:ba7650f404af 118 * The number of byte read.
aravindsv 0:ba7650f404af 119 */
aravindsv 0:ba7650f404af 120 int read(char *data, int size);
aravindsv 0:ba7650f404af 121
aravindsv 0:ba7650f404af 122 /** Gives the ethernet address of the mbed.
aravindsv 0:ba7650f404af 123 *
aravindsv 0:ba7650f404af 124 * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
aravindsv 0:ba7650f404af 125 */
aravindsv 0:ba7650f404af 126 void address(char *mac);
aravindsv 0:ba7650f404af 127
aravindsv 0:ba7650f404af 128 /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up.
aravindsv 0:ba7650f404af 129 *
aravindsv 0:ba7650f404af 130 * @returns
aravindsv 0:ba7650f404af 131 * 0 if no ethernet link is pressent,
aravindsv 0:ba7650f404af 132 * 1 if an ethernet link is pressent.
aravindsv 0:ba7650f404af 133 *
aravindsv 0:ba7650f404af 134 * Example:
aravindsv 0:ba7650f404af 135 * @code
aravindsv 0:ba7650f404af 136 * // Using the Ethernet link function
aravindsv 0:ba7650f404af 137 * #include "mbed.h"
aravindsv 0:ba7650f404af 138 *
aravindsv 0:ba7650f404af 139 * Ethernet eth;
aravindsv 0:ba7650f404af 140 *
aravindsv 0:ba7650f404af 141 * int main() {
aravindsv 0:ba7650f404af 142 * wait(1); // Needed after startup.
aravindsv 0:ba7650f404af 143 * if (eth.link()) {
aravindsv 0:ba7650f404af 144 * printf("online\n");
aravindsv 0:ba7650f404af 145 * } else {
aravindsv 0:ba7650f404af 146 * printf("offline\n");
aravindsv 0:ba7650f404af 147 * }
aravindsv 0:ba7650f404af 148 * }
aravindsv 0:ba7650f404af 149 * @endcode
aravindsv 0:ba7650f404af 150 */
aravindsv 0:ba7650f404af 151 int link();
aravindsv 0:ba7650f404af 152
aravindsv 0:ba7650f404af 153 /** Sets the speed and duplex parameters of an ethernet link
aravindsv 0:ba7650f404af 154 *
aravindsv 0:ba7650f404af 155 * - AutoNegotiate Auto negotiate speed and duplex
aravindsv 0:ba7650f404af 156 * - HalfDuplex10 10 Mbit, half duplex
aravindsv 0:ba7650f404af 157 * - FullDuplex10 10 Mbit, full duplex
aravindsv 0:ba7650f404af 158 * - HalfDuplex100 100 Mbit, half duplex
aravindsv 0:ba7650f404af 159 * - FullDuplex100 100 Mbit, full duplex
aravindsv 0:ba7650f404af 160 *
aravindsv 0:ba7650f404af 161 * @param mode the speed and duplex mode to set the link to:
aravindsv 0:ba7650f404af 162 */
aravindsv 0:ba7650f404af 163 void set_link(Mode mode);
aravindsv 0:ba7650f404af 164 };
aravindsv 0:ba7650f404af 165
aravindsv 0:ba7650f404af 166 } // namespace mbed
aravindsv 0:ba7650f404af 167
aravindsv 0:ba7650f404af 168 #endif
aravindsv 0:ba7650f404af 169
aravindsv 0:ba7650f404af 170 #endif