mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/ethernet_api.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
165:d1b4690b3f8b 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup hal */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 172:65be27845400 6 * SPDX-License-Identifier: Apache-2.0
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 9 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 10 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 11 *
<> 128:9bcdf88f62b0 12 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 13 *
<> 128:9bcdf88f62b0 14 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 15 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 17 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 18 * limitations under the License.
<> 128:9bcdf88f62b0 19 */
<> 128:9bcdf88f62b0 20 #ifndef MBED_ETHERNET_API_H
<> 128:9bcdf88f62b0 21 #define MBED_ETHERNET_API_H
<> 128:9bcdf88f62b0 22
<> 128:9bcdf88f62b0 23 #include "device.h"
<> 128:9bcdf88f62b0 24
<> 128:9bcdf88f62b0 25 #if DEVICE_ETHERNET
<> 128:9bcdf88f62b0 26
<> 128:9bcdf88f62b0 27 #ifdef __cplusplus
<> 128:9bcdf88f62b0 28 extern "C" {
<> 128:9bcdf88f62b0 29 #endif
<> 128:9bcdf88f62b0 30
<> 128:9bcdf88f62b0 31 // Connection constants
<> 128:9bcdf88f62b0 32
<> 128:9bcdf88f62b0 33 int ethernet_init(void);
<> 128:9bcdf88f62b0 34 void ethernet_free(void);
<> 128:9bcdf88f62b0 35
<> 128:9bcdf88f62b0 36 // write size bytes from data to ethernet buffer
<> 128:9bcdf88f62b0 37 // return num bytes written
<> 128:9bcdf88f62b0 38 // or -1 if size is too big
<> 128:9bcdf88f62b0 39 int ethernet_write(const char *data, int size);
<> 128:9bcdf88f62b0 40
<> 128:9bcdf88f62b0 41 // send ethernet write buffer, returning the packet size sent
<> 128:9bcdf88f62b0 42 int ethernet_send(void);
<> 128:9bcdf88f62b0 43
AnnaBridge 165:d1b4690b3f8b 44 // receive from ethernet buffer, returning packet size, or 0 if no packet
<> 128:9bcdf88f62b0 45 int ethernet_receive(void);
<> 128:9bcdf88f62b0 46
<> 128:9bcdf88f62b0 47 // read size bytes in to data, return actual num bytes read (0..size)
<> 128:9bcdf88f62b0 48 // if data == NULL, throw the bytes away
<> 128:9bcdf88f62b0 49 int ethernet_read(char *data, int size);
<> 128:9bcdf88f62b0 50
<> 128:9bcdf88f62b0 51 // get the ethernet address
<> 128:9bcdf88f62b0 52 void ethernet_address(char *mac);
<> 128:9bcdf88f62b0 53
<> 128:9bcdf88f62b0 54 // see if the link is up
<> 128:9bcdf88f62b0 55 int ethernet_link(void);
<> 128:9bcdf88f62b0 56
<> 128:9bcdf88f62b0 57 // force link settings
<> 128:9bcdf88f62b0 58 void ethernet_set_link(int speed, int duplex);
<> 128:9bcdf88f62b0 59
<> 128:9bcdf88f62b0 60 #ifdef __cplusplus
<> 128:9bcdf88f62b0 61 }
<> 128:9bcdf88f62b0 62 #endif
<> 128:9bcdf88f62b0 63
<> 128:9bcdf88f62b0 64 #endif
<> 128:9bcdf88f62b0 65
<> 128:9bcdf88f62b0 66 #endif
<> 128:9bcdf88f62b0 67
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 /** @}*/