Elijah Stanger-Jones / mbed-dev

Lightweight Mbed Library for STM F4 and F7

hal/ethernet_api.h@2:0edeaf13dfb2, 2021-02-04 (annotated)

Committer:
elijahsj
Date:
Thu Feb 04 20:44:34 2021 +0000
Revision:
2:0edeaf13dfb2
Parent:
0:083111ae2a11 
modfiied for spine board;

Who changed what in which revision?

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