BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/ethernet_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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