Gan likun / mbed-dev11

hal/ethernet_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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