mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/ethernet_api.h@181:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
181:57724642e740
Parent:
149:156823d33999
Child:
184:08ed48f1de7f
mbed-dev library. Release version 159.

Who changed what in which revision?

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