Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/Ethernet.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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