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