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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
184:08ed48f1de7f 
mbed library release version 165

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