Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/ethernet_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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