ethernet_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_ETHERNET_API_H
00023 #define MBED_ETHERNET_API_H
00024 
00025 #include "device.h"
00026 
00027 #if DEVICE_ETHERNET
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif
00032 
00033 // Connection constants
00034 
00035 int ethernet_init(void);
00036 void ethernet_free(void);
00037 
00038 // write size bytes from data to ethernet buffer
00039 // return num bytes written
00040 // or -1 if size is too big
00041 int ethernet_write(const char *data, int size);
00042 
00043 // send ethernet write buffer, returning the packet size sent
00044 int ethernet_send(void);
00045 
00046 // recieve from ethernet buffer, returning packet size, or 0 if no packet
00047 int ethernet_receive(void);
00048 
00049 // read size bytes in to data, return actual num bytes read (0..size)
00050 // if data == NULL, throw the bytes away
00051 int ethernet_read(char *data, int size);
00052 
00053 // get the ethernet address
00054 void ethernet_address(char *mac);
00055 
00056 // see if the link is up
00057 int ethernet_link(void);
00058 
00059 // force link settings
00060 void ethernet_set_link(int speed, int duplex);
00061 
00062 #ifdef __cplusplus
00063 }
00064 #endif
00065 
00066 #endif
00067 
00068 #endif
00069 
00070