Gleb Klochkov / Mbed OS Climatcontroll_Main

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   esp8266-driver

mbed-os/drivers/Ethernet.h@0:2f0e1e23c242, 2018-04-13 (annotated)

Committer:
glebiuskv
Date:
Fri Apr 13 08:53:46 2018 +0000
Revision:
0:2f0e1e23c242
initial

Who changed what in which revision?

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