Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

drivers/Ethernet.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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