DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/Ethernet.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

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