cc y / mbed

ads1115 only

Fork of mbed by mbed official

Ethernet.h@59:0883845fe643, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:12:58 2013 +0000
Revision:
59:0883845fe643
Parent:
55:d722ed6a4237
Child:
65:5798e58a58b1
Add pinmap NC terminators for LPC1768 CAN.

Update the license from MIT to Apache v2.

Make the semihost code target independent using opportune defines for the UID and MAC.

Who changed what in which revision?

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