os_whiteboard.h

00001 /*
00002  * Copyright (c) 2014-2016 ARM Limited. All rights reserved.
00003  *
00004  * SPDX-License-Identifier: LicenseRef-PBL
00005  *
00006  * Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * https://www.mbed.com/licenses/PBL-1.0
00010  *
00011  * See the License for the specific language governing permissions and limitations under the License.
00012  *
00013  */
00014 #ifndef OS_WHITEBOARD_H
00015 #define OS_WHITEBOARD_H
00016 
00017 #include "ns_types.h"
00018 
00019 /**
00020  * \file os_whiteboard.h
00021  * \brief Platform API to modify the operating system routing table.
00022  * API to modify the operating system routing table and neighbor cache.
00023  * Required on Linux. Not needed on embedded systems.
00024  */
00025 
00026 /** Mode selection */
00027 enum add_or_remove {ADD = 1, REMOVE = 0};
00028 
00029 #ifndef __linux__
00030 /* Use DUMMY functions on non-Linux platforms. */
00031 /** \cond DOXYGEN_IGNORE */
00032 #define whiteboard_os_modify(x,y) ((void)(x),(void)(y))
00033 /** \endcond */
00034 
00035 #else /* LINUX */
00036 
00037 /** Modify the operating system whiteboard.
00038  * Add entries to or remove from the OS routing table.
00039  * \param address IPv6 address.
00040  * \param add_or_remove select whether to add or remove address.
00041  */
00042 void whiteboard_os_modify(const uint8_t address[static 16], enum add_or_remove mode);
00043 
00044 #endif
00045 
00046 
00047 #endif /* OS_WHITEBOARD_H */