Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/ethernet_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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