Milen Pavlov / XRange_mbed_src

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.

Dependents:   XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver

api/Ethernet.h@336:1e18a06a987b, 2015-01-15 (annotated)

Committer:
dudmuck
Date:
Thu Jan 15 02:25:40 2015 +0000
Revision:
336:1e18a06a987b
updated to rev443 of official mbed-src

Who changed what in which revision?

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