PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/Ethernet.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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