Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-os/drivers/Ethernet.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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