Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/ethernet_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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