Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

Ethernet.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
27:7110ebee3484
Child:
43:e2ed12d17f06
Soundharrajan

Who changed what in which revision?

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