Eric Lewiston / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/ethernet_api.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_ETHERNET_API_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_ETHERNET_API_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "device.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_ETHERNET
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 30 extern "C" {
mbed_official 0:fd0d7bdfcdc2 31 #endif
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 // Connection constants
mbed_official 0:fd0d7bdfcdc2 34
mbed_official 0:fd0d7bdfcdc2 35 int ethernet_init(void);
mbed_official 0:fd0d7bdfcdc2 36 void ethernet_free(void);
mbed_official 0:fd0d7bdfcdc2 37
mbed_official 0:fd0d7bdfcdc2 38 // write size bytes from data to ethernet buffer
mbed_official 0:fd0d7bdfcdc2 39 // return num bytes written
mbed_official 0:fd0d7bdfcdc2 40 // or -1 if size is too big
mbed_official 0:fd0d7bdfcdc2 41 int ethernet_write(const char *data, int size);
mbed_official 0:fd0d7bdfcdc2 42
mbed_official 0:fd0d7bdfcdc2 43 // send ethernet write buffer, returning the packet size sent
mbed_official 0:fd0d7bdfcdc2 44 int ethernet_send(void);
mbed_official 0:fd0d7bdfcdc2 45
mbed_official 0:fd0d7bdfcdc2 46 // recieve from ethernet buffer, returning packet size, or 0 if no packet
mbed_official 0:fd0d7bdfcdc2 47 int ethernet_receive(void);
mbed_official 0:fd0d7bdfcdc2 48
mbed_official 0:fd0d7bdfcdc2 49 // read size bytes in to data, return actual num bytes read (0..size)
mbed_official 0:fd0d7bdfcdc2 50 // if data == NULL, throw the bytes away
mbed_official 0:fd0d7bdfcdc2 51 int ethernet_read(char *data, int size);
mbed_official 0:fd0d7bdfcdc2 52
mbed_official 0:fd0d7bdfcdc2 53 // get the ethernet address
mbed_official 0:fd0d7bdfcdc2 54 void ethernet_address(char *mac);
mbed_official 0:fd0d7bdfcdc2 55
mbed_official 0:fd0d7bdfcdc2 56 // see if the link is up
mbed_official 0:fd0d7bdfcdc2 57 int ethernet_link(void);
mbed_official 0:fd0d7bdfcdc2 58
mbed_official 0:fd0d7bdfcdc2 59 // force link settings
mbed_official 0:fd0d7bdfcdc2 60 void ethernet_set_link(int speed, int duplex);
mbed_official 0:fd0d7bdfcdc2 61
mbed_official 0:fd0d7bdfcdc2 62 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 63 }
mbed_official 0:fd0d7bdfcdc2 64 #endif
mbed_official 0:fd0d7bdfcdc2 65
mbed_official 0:fd0d7bdfcdc2 66 #endif
mbed_official 0:fd0d7bdfcdc2 67
mbed_official 0:fd0d7bdfcdc2 68 #endif
mbed_official 0:fd0d7bdfcdc2 69