Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

Ethernet.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Child:
18:b3c9f16cbb96
A shiny new version

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
rolf.meyer@arm.com 11:1c1ebd0324fa 55 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 56 * Writes into an outgoing ethernet packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 57 *
rolf.meyer@arm.com 11:1c1ebd0324fa 58 * It will append size bytes of data to the previously written bytes.
rolf.meyer@arm.com 11:1c1ebd0324fa 59 *
rolf.meyer@arm.com 11:1c1ebd0324fa 60 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 61 * data - An array to write.
rolf.meyer@arm.com 11:1c1ebd0324fa 62 * size - The size of data.
rolf.meyer@arm.com 11:1c1ebd0324fa 63 *
rolf.meyer@arm.com 11:1c1ebd0324fa 64 * Returns:
rolf.meyer@arm.com 11:1c1ebd0324fa 65 * The number of written bytes.
rolf.meyer@arm.com 11:1c1ebd0324fa 66 */
rolf.meyer@arm.com 11:1c1ebd0324fa 67 int write(const char *data, int size);
rolf.meyer@arm.com 11:1c1ebd0324fa 68
rolf.meyer@arm.com 11:1c1ebd0324fa 69 /* Function: send
rolf.meyer@arm.com 11:1c1ebd0324fa 70 * Send an outgoing ethernet packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 71 *
rolf.meyer@arm.com 11:1c1ebd0324fa 72 * After filling in the data in an ethernet packet it must be send.
rolf.meyer@arm.com 11:1c1ebd0324fa 73 * Send will provide a new packet to write to.
rolf.meyer@arm.com 11:1c1ebd0324fa 74 *
rolf.meyer@arm.com 11:1c1ebd0324fa 75 * Returns:
rolf.meyer@arm.com 11:1c1ebd0324fa 76 * 0 - If the sending was failed.
rolf.meyer@arm.com 11:1c1ebd0324fa 77 * 1 - If the package is successfully sent.
rolf.meyer@arm.com 11:1c1ebd0324fa 78 */
rolf.meyer@arm.com 11:1c1ebd0324fa 79 int send();
rolf.meyer@arm.com 11:1c1ebd0324fa 80
rolf.meyer@arm.com 11:1c1ebd0324fa 81 /* Function: receive
rolf.meyer@arm.com 11:1c1ebd0324fa 82 * Recevies an arrived ethernet packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 83 *
rolf.meyer@arm.com 11:1c1ebd0324fa 84 * Receiving an ethernet packet will drop the last received ethernet packet
rolf.meyer@arm.com 11:1c1ebd0324fa 85 * and make a new ethernet packet ready to read.
rolf.meyer@arm.com 11:1c1ebd0324fa 86 * If no ethernet packet is arrived it will return 0.
rolf.meyer@arm.com 11:1c1ebd0324fa 87 *
rolf.meyer@arm.com 11:1c1ebd0324fa 88 * Returns:
rolf.meyer@arm.com 11:1c1ebd0324fa 89 * 0 - If no ethernet packet is arrived.
rolf.meyer@arm.com 11:1c1ebd0324fa 90 * The size of the arrived packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 91 */
rolf.meyer@arm.com 11:1c1ebd0324fa 92 int receive();
rolf.meyer@arm.com 11:1c1ebd0324fa 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 95 * Read from an recevied ethernet packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 96 *
rolf.meyer@arm.com 11:1c1ebd0324fa 97 * After receive returnd a number bigger than 0it is
rolf.meyer@arm.com 11:1c1ebd0324fa 98 * possible to read bytes from this packet.
rolf.meyer@arm.com 11:1c1ebd0324fa 99 * Read will write up to size bytes into data.
rolf.meyer@arm.com 11:1c1ebd0324fa 100 *
rolf.meyer@arm.com 11:1c1ebd0324fa 101 * It is possible to use read multible times.
rolf.meyer@arm.com 11:1c1ebd0324fa 102 * Each time read will start reading after the last read byte before.
rolf.meyer@arm.com 11:1c1ebd0324fa 103 *
rolf.meyer@arm.com 11:1c1ebd0324fa 104 * Returns:
rolf.meyer@arm.com 11:1c1ebd0324fa 105 * The number of byte read.
rolf.meyer@arm.com 11:1c1ebd0324fa 106 */
rolf.meyer@arm.com 11:1c1ebd0324fa 107 int read(char *data, int size);
rolf.meyer@arm.com 11:1c1ebd0324fa 108
rolf.meyer@arm.com 11:1c1ebd0324fa 109 /* Function: address
rolf.meyer@arm.com 11:1c1ebd0324fa 110 * Gives the ethernet address of the mbed.
rolf.meyer@arm.com 11:1c1ebd0324fa 111 *
rolf.meyer@arm.com 11:1c1ebd0324fa 112 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 113 * mac - Must be a pointer to a 6 byte char array to copy the ethernet address in.
rolf.meyer@arm.com 11:1c1ebd0324fa 114 */
rolf.meyer@arm.com 11:1c1ebd0324fa 115 void address(char *mac);
rolf.meyer@arm.com 11:1c1ebd0324fa 116
rolf.meyer@arm.com 11:1c1ebd0324fa 117 /* Function: link
rolf.meyer@arm.com 11:1c1ebd0324fa 118 * Returns if an ethernet link is pressent or not.
rolf.meyer@arm.com 11:1c1ebd0324fa 119 *
rolf.meyer@arm.com 11:1c1ebd0324fa 120 * Returns:
rolf.meyer@arm.com 11:1c1ebd0324fa 121 * 0 - If no ethernet link is pressent.
rolf.meyer@arm.com 11:1c1ebd0324fa 122 * 1 - If an ethernet link is pressent.
rolf.meyer@arm.com 11:1c1ebd0324fa 123 */
rolf.meyer@arm.com 11:1c1ebd0324fa 124 int link();
rolf.meyer@arm.com 11:1c1ebd0324fa 125
rolf.meyer@arm.com 11:1c1ebd0324fa 126 };
rolf.meyer@arm.com 11:1c1ebd0324fa 127
rolf.meyer@arm.com 11:1c1ebd0324fa 128 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 129
rolf.meyer@arm.com 11:1c1ebd0324fa 130 #endif