Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/ethernet_api.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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