os_whiteboard.h

00001 /*
00002  * Copyright (c) 2014-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef OS_WHITEBOARD_H
00018 #define OS_WHITEBOARD_H
00019 
00020 #include "ns_types.h"
00021 
00022 /**
00023  * \file os_whiteboard.h
00024  * \brief Platform API to modify the operating system routing table.
00025  * API to modify the operating system routing table and neighbor cache.
00026  * Required on Linux. Not needed on embedded systems.
00027  */
00028 
00029 /** Mode selection */
00030 enum add_or_remove {ADD = 1, REMOVE = 0};
00031 
00032 #ifndef __linux__
00033 /* Use DUMMY functions on non-Linux platforms. */
00034 /** \cond DOXYGEN_IGNORE */
00035 #define whiteboard_os_modify(x,y) ((void)(x),(void)(y))
00036 /** \endcond */
00037 
00038 #else /* LINUX */
00039 
00040 /** Modify the operating system whiteboard.
00041  * Add entries to or remove from the OS routing table.
00042  * \param address IPv6 address.
00043  * \param add_or_remove select whether to add or remove address.
00044  */
00045 void whiteboard_os_modify(const uint8_t address[static 16], enum add_or_remove mode);
00046 
00047 #endif
00048 
00049 
00050 #endif /* OS_WHITEBOARD_H */