mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Ethernet.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
165:d1b4690b3f8b
mbed library. Release version 158

Who changed what in which revision?

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