Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

hal/ethernet_api.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
capi/ethernet_api.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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