ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #12500 from rajkan01/ethernet_remove_deprecate 

Remove the deprecated ethernet APIs
pull/12526/head
Martin Kojtal 2020-02-27 08:46:42 +00:00 committed by GitHub
parent 5c16018c96 c4a54e38cb
commit 10842f7a57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 0 additions and 322 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
drivers/Ethernet.h
View File

@ -1,223 +0,0 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MBED_ETHERNET_H
#define MBED_ETHERNET_H
#include "platform/platform.h"
#include "platform/NonCopyable.h"
#if DEVICE_ETHERNET || defined(DOXYGEN_ONLY)
namespace mbed {
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_Ethernet Ethernet class
* @{
*/
/** An ethernet interface, to use with the ethernet pins.
*
* @deprecated
* EthInterface is now the preferred way to get an Ethernet object.
* Alternatively, use NetworkInterface to get an instance of an appropriate network
* interface (WiFi or Ethernet).
*
* @note Synchronization level: Not protected
*
* Example:
* @code
* // Read destination and source from every ethernet packet
*
* #include "mbed.h"
*
* Ethernet eth;
*
* int main() {
* char buf[0x600];
*
* while(1) {
* int size = eth.receive();
* if(size > 0) {
* eth.read(buf, size);
* printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
* buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
* printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
* buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
* }
*
* wait(1);
* }
* }
* @endcode
*/
class
MBED_DEPRECATED(
"EthInterface is now the preferred way to get an Ethernet object. "
"Alternatively, use NetworkInterface to get an instance of an appropriate network "
"interface (WiFi or Ethernet)."
) Ethernet : private NonCopyable<Ethernet> {
public:
/**
* @deprecated
* Initialize the ethernet interface.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
Ethernet();
/**
* @deprecated
* Powers the hardware down.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
virtual ~Ethernet();
enum Mode {
AutoNegotiate,
HalfDuplex10,
FullDuplex10,
HalfDuplex100,
FullDuplex100
};
/**
* @deprecated
* Writes into an outgoing ethernet packet.
*
* It will append size bytes of data to the previously written bytes.
*
* @param data An array to write.
* @param size The size of data.
*
* @returns
* The number of written bytes.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int write(const char *data, int size);
/**
* @deprecated
* Send an outgoing ethernet packet.
*
* After filling in the data in an ethernet packet it must be send.
* Send will provide a new packet to write to.
*
* @returns
* 0 if the sending was failed,
* or the size of the packet successfully sent.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int send();
/**
* @deprecated
* Receives an arrived ethernet packet.
*
* Receiving an ethernet packet will drop the last received ethernet packet
* and make a new ethernet packet ready to read.
* If no ethernet packet is arrived it will return 0.
*
* @returns
* 0 if no ethernet packet is arrived,
* or the size of the arrived packet.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int receive();
/**
* @deprecated
* Read from an received ethernet packet.
*
* After receive returned a number bigger than 0 it is
* possible to read bytes from this packet.
*
* @param data Pointer to data packet
* @param size Size of data to be read.
* @returns The number of byte read.
*
* @note It is possible to use read multiple times.
* Each time read will start reading after the last read byte before.
*
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int read(char *data, int size);
/**
* @deprecated
* Gives the ethernet address of the mbed.
*
* @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
void address(char *mac);
/**
* @deprecated
* Returns if an ethernet link is present or not. It takes a while after Ethernet initialization to show up.
*
* @returns
* 0 if no ethernet link is present,
* 1 if an ethernet link is present.
*
* Example:
* @code
* // Using the Ethernet link function
* #include "mbed.h"
*
* Ethernet eth;
*
* int main() {
* wait(1); // Needed after startup.
* if (eth.link()) {
* printf("online\n");
* } else {
* printf("offline\n");
* }
* }
* @endcode
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
int link();
/**
* @deprecated
* Sets the speed and duplex parameters of an ethernet link
*
* - AutoNegotiate Auto negotiate speed and duplex
* - HalfDuplex10 10 Mbit, half duplex
* - FullDuplex10 10 Mbit, full duplex
* - HalfDuplex100 100 Mbit, half duplex
* - FullDuplex100 100 Mbit, full duplex
*
* @param mode the speed and duplex mode to set the link to:
*/
MBED_DEPRECATED("The class has been deprecated and will be removed in the future.")
void set_link(Mode mode);
};
/** @}*/
/** @}*/
} // namespace mbed
#endif
#endif

98
drivers/source/Ethernet.cpp
View File

@ -1,98 +0,0 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "drivers/Ethernet.h"
#if DEVICE_ETHERNET
#include "hal/ethernet_api.h"
namespace mbed {
Ethernet::Ethernet()
{
ethernet_init();
}
Ethernet::~Ethernet()
{
ethernet_free();
}
int Ethernet::write(const char *data, int size)
{
return ethernet_write(data, size);
}
int Ethernet::send()
{
return ethernet_send();
}
int Ethernet::receive()
{
return ethernet_receive();
}
int Ethernet::read(char *data, int size)
{
return ethernet_read(data, size);
}
void Ethernet::address(char *mac)
{
return ethernet_address(mac);
}
int Ethernet::link()
{
return ethernet_link();
}
void Ethernet::set_link(Mode mode)
{
int speed = -1;
int duplex = 0;
switch (mode) {
case AutoNegotiate :
speed = -1;
duplex = 0;
break;
case HalfDuplex10 :
speed = 0;
duplex = 0;
break;
case FullDuplex10 :
speed = 0;
duplex = 1;
break;
case HalfDuplex100 :
speed = 1;
duplex = 0;
break;
case FullDuplex100 :
speed = 1;
duplex = 1;
break;
}
ethernet_set_link(speed, duplex);
}
} // namespace mbed
#endif

1
mbed.h
View File

@ -67,7 +67,6 @@
#include "drivers/SPISlave.h"
#include "drivers/I2C.h"
#include "drivers/I2CSlave.h"
#include "drivers/Ethernet.h"
#include "drivers/CAN.h"
#include "drivers/RawSerial.h"
#include "drivers/UnbufferedSerial.h"