Gan likun / mbed-dev11

1232

drivers/Ethernet.h@0:06036f8bee2d, 23 months ago (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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