Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/Ethernet.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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