PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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