Lancaster University / mbed-src

Lancaster University's (short term!) clone of mbed-src for micro:bit. This is a copy of the github branch https://github.com/lancaster-university/mbed-classic

Fork of mbed-src by mbed official

hal/ethernet_api.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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