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