Describes predefine macros for mbed online compiler (armcc)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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