TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/hal/ethernet_api.h@2:5acdd8565d02, 2017-02-25 (annotated)

Committer:
elmot
Date:
Sat Feb 25 00:23:53 2017 +0000
Revision:
2:5acdd8565d02
Parent:
1:d0dfbce63a89 
Ready to show

Who changed what in which revision?

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