KEN OGAMI / mbed-dev-bin

Forking mbed-dev-bin

Fork of mbed-dev-bin by Lancaster University

ethernet_api.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

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