Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/Ethernet.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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