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