Vladimir Vana / mbed

pro vyuku PSS v Jecne

Ethernet.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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