Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/Ethernet.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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