jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

Ethernet.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
44:24d45a770a51
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_ETHERNET_H
emilmont 44:24d45a770a51 23 #define MBED_ETHERNET_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #if DEVICE_ETHERNET
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 namespace mbed {
emilmont 44:24d45a770a51 30
emilmont 44:24d45a770a51 31 /** An ethernet interface, to use with the ethernet pins.
emilmont 44:24d45a770a51 32 *
emilmont 44:24d45a770a51 33 * Example:
emilmont 44:24d45a770a51 34 * @code
emilmont 44:24d45a770a51 35 * // Read destination and source from every ethernet packet
emilmont 44:24d45a770a51 36 *
emilmont 44:24d45a770a51 37 * #include "mbed.h"
emilmont 44:24d45a770a51 38 *
emilmont 44:24d45a770a51 39 * Ethernet eth;
emilmont 44:24d45a770a51 40 *
emilmont 44:24d45a770a51 41 * int main() {
emilmont 44:24d45a770a51 42 * char buf[0x600];
emilmont 44:24d45a770a51 43 *
emilmont 44:24d45a770a51 44 * while(1) {
emilmont 44:24d45a770a51 45 * int size = eth.receive();
emilmont 44:24d45a770a51 46 * if(size > 0) {
emilmont 44:24d45a770a51 47 * eth.read(buf, size);
emilmont 44:24d45a770a51 48 * printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
emilmont 44:24d45a770a51 49 * buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
emilmont 44:24d45a770a51 50 * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
emilmont 44:24d45a770a51 51 * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
emilmont 44:24d45a770a51 52 * }
emilmont 44:24d45a770a51 53 *
emilmont 44:24d45a770a51 54 * wait(1);
emilmont 44:24d45a770a51 55 * }
emilmont 44:24d45a770a51 56 * }
emilmont 44:24d45a770a51 57 * @endcode
emilmont 44:24d45a770a51 58 */
emilmont 44:24d45a770a51 59 class Ethernet {
emilmont 44:24d45a770a51 60
emilmont 44:24d45a770a51 61 public:
emilmont 44:24d45a770a51 62
emilmont 44:24d45a770a51 63 /** Initialise the ethernet interface.
emilmont 44:24d45a770a51 64 */
emilmont 44:24d45a770a51 65 Ethernet();
emilmont 44:24d45a770a51 66
emilmont 44:24d45a770a51 67 /** Powers the hardware down.
emilmont 44:24d45a770a51 68 */
emilmont 44:24d45a770a51 69 virtual ~Ethernet();
emilmont 44:24d45a770a51 70
emilmont 44:24d45a770a51 71 enum Mode {
emilmont 44:24d45a770a51 72 AutoNegotiate,
emilmont 44:24d45a770a51 73 HalfDuplex10,
emilmont 44:24d45a770a51 74 FullDuplex10,
emilmont 44:24d45a770a51 75 HalfDuplex100,
emilmont 44:24d45a770a51 76 FullDuplex100
emilmont 44:24d45a770a51 77 };
emilmont 44:24d45a770a51 78
emilmont 44:24d45a770a51 79 /** Writes into an outgoing ethernet packet.
emilmont 44:24d45a770a51 80 *
emilmont 44:24d45a770a51 81 * It will append size bytes of data to the previously written bytes.
emilmont 44:24d45a770a51 82 *
emilmont 44:24d45a770a51 83 * @param data An array to write.
emilmont 44:24d45a770a51 84 * @param size The size of data.
emilmont 44:24d45a770a51 85 *
emilmont 44:24d45a770a51 86 * @returns
emilmont 44:24d45a770a51 87 * The number of written bytes.
emilmont 44:24d45a770a51 88 */
emilmont 44:24d45a770a51 89 int write(const char *data, int size);
emilmont 44:24d45a770a51 90
emilmont 44:24d45a770a51 91 /** Send an outgoing ethernet packet.
emilmont 44:24d45a770a51 92 *
emilmont 44:24d45a770a51 93 * After filling in the data in an ethernet packet it must be send.
emilmont 44:24d45a770a51 94 * Send will provide a new packet to write to.
emilmont 44:24d45a770a51 95 *
emilmont 44:24d45a770a51 96 * @returns
emilmont 44:24d45a770a51 97 * 0 if the sending was failed,
emilmont 44:24d45a770a51 98 * 1 if the package is successfully sent.
emilmont 44:24d45a770a51 99 */
emilmont 44:24d45a770a51 100 int send();
emilmont 44:24d45a770a51 101
emilmont 44:24d45a770a51 102 /** Recevies an arrived ethernet packet.
emilmont 44:24d45a770a51 103 *
emilmont 44:24d45a770a51 104 * Receiving an ethernet packet will drop the last received ethernet packet
emilmont 44:24d45a770a51 105 * and make a new ethernet packet ready to read.
emilmont 44:24d45a770a51 106 * If no ethernet packet is arrived it will return 0.
emilmont 44:24d45a770a51 107 *
emilmont 44:24d45a770a51 108 * @returns
emilmont 44:24d45a770a51 109 * 0 if no ethernet packet is arrived,
emilmont 44:24d45a770a51 110 * or the size of the arrived packet.
emilmont 44:24d45a770a51 111 */
emilmont 44:24d45a770a51 112 int receive();
emilmont 44:24d45a770a51 113
emilmont 44:24d45a770a51 114 /** Read from an recevied ethernet packet.
emilmont 44:24d45a770a51 115 *
emilmont 44:24d45a770a51 116 * After receive returnd a number bigger than 0it is
emilmont 44:24d45a770a51 117 * possible to read bytes from this packet.
emilmont 44:24d45a770a51 118 * Read will write up to size bytes into data.
emilmont 44:24d45a770a51 119 *
emilmont 44:24d45a770a51 120 * It is possible to use read multible times.
emilmont 44:24d45a770a51 121 * Each time read will start reading after the last read byte before.
emilmont 44:24d45a770a51 122 *
emilmont 44:24d45a770a51 123 * @returns
emilmont 44:24d45a770a51 124 * The number of byte read.
emilmont 44:24d45a770a51 125 */
emilmont 44:24d45a770a51 126 int read(char *data, int size);
emilmont 44:24d45a770a51 127
emilmont 44:24d45a770a51 128 /** Gives the ethernet address of the mbed.
emilmont 44:24d45a770a51 129 *
emilmont 44:24d45a770a51 130 * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
emilmont 44:24d45a770a51 131 */
emilmont 44:24d45a770a51 132 void address(char *mac);
emilmont 44:24d45a770a51 133
emilmont 44:24d45a770a51 134 /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up.
emilmont 44:24d45a770a51 135 *
emilmont 44:24d45a770a51 136 * @returns
emilmont 44:24d45a770a51 137 * 0 if no ethernet link is pressent,
emilmont 44:24d45a770a51 138 * 1 if an ethernet link is pressent.
emilmont 44:24d45a770a51 139 *
emilmont 44:24d45a770a51 140 * Example:
emilmont 44:24d45a770a51 141 * @code
emilmont 44:24d45a770a51 142 * // Using the Ethernet link function
emilmont 44:24d45a770a51 143 * #include "mbed.h"
emilmont 44:24d45a770a51 144 *
emilmont 44:24d45a770a51 145 * Ethernet eth;
emilmont 44:24d45a770a51 146 *
emilmont 44:24d45a770a51 147 * int main() {
emilmont 44:24d45a770a51 148 * wait(1); // Needed after startup.
emilmont 44:24d45a770a51 149 * if (eth.link()) {
emilmont 44:24d45a770a51 150 * printf("online\n");
emilmont 44:24d45a770a51 151 * } else {
emilmont 44:24d45a770a51 152 * printf("offline\n");
emilmont 44:24d45a770a51 153 * }
emilmont 44:24d45a770a51 154 * }
emilmont 44:24d45a770a51 155 * @endcode
emilmont 44:24d45a770a51 156 */
emilmont 44:24d45a770a51 157 int link();
emilmont 44:24d45a770a51 158
emilmont 44:24d45a770a51 159 /** Sets the speed and duplex parameters of an ethernet link
emilmont 44:24d45a770a51 160 *
emilmont 44:24d45a770a51 161 * - AutoNegotiate Auto negotiate speed and duplex
emilmont 44:24d45a770a51 162 * - HalfDuplex10 10 Mbit, half duplex
emilmont 44:24d45a770a51 163 * - FullDuplex10 10 Mbit, full duplex
emilmont 44:24d45a770a51 164 * - HalfDuplex100 100 Mbit, half duplex
emilmont 44:24d45a770a51 165 * - FullDuplex100 100 Mbit, full duplex
emilmont 44:24d45a770a51 166 *
emilmont 44:24d45a770a51 167 * @param mode the speed and duplex mode to set the link to:
emilmont 44:24d45a770a51 168 */
emilmont 44:24d45a770a51 169 void set_link(Mode mode);
emilmont 44:24d45a770a51 170 };
emilmont 44:24d45a770a51 171
emilmont 44:24d45a770a51 172 } // namespace mbed
emilmont 44:24d45a770a51 173
emilmont 44:24d45a770a51 174 #endif
emilmont 44:24d45a770a51 175
emilmont 44:24d45a770a51 176 #endif