Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

hal/ethernet_api.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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