Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Ethernet.h@20:029aa53d7323, 2010-06-03 (annotated)

Committer:
simon
Date:
Thu Jun 03 11:17:50 2010 +0000
Revision:
20:029aa53d7323
Parent:
18:b3c9f16cbb96
Child:
27:7110ebee3484
* Add SPISlave, SPIHalfDuplex, SerialHalfDuplex

 * Add I2C repeated start

 * Add ethernet set_link()

 * Add documentation for wait()

Who changed what in which revision?

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