jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

Ethernet.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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