Gan likun / mbed-dev

00

drivers/Ethernet.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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