Gonzalo Matarrubia / Mbed LPC1549 mod

This repo contains the libraries of Mbed for LPC1549 with following changes: - IAP commands. - EEPROM write and read. - UART write and read (public) - CAN can_s -> LPC_C_CAN0_Type *can

mbed/Ethernet.h@0:820a69dfd200, 2015-04-14 (annotated)

Committer:
gmatarrubia
Date:
Tue Apr 14 15:00:13 2015 +0200
Revision:
0:820a69dfd200
Initial repo. IAP commands, EEPROM write/read, UART write/read, CAN

Who changed what in which revision?

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