Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/hal/ethernet_api.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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