thread_dhcpv6_server.h

00001 /*
00002  * Copyright (c) 2014-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: BSD-3-Clause
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holder nor the
00014  *    names of its contributors may be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 /**
00031  * \file thread_dhcpv6_server.h
00032  * \brief Thread specific DHCP server.
00033  *
00034  * \warning This api will be removed as there is no Thread specific modifications anymore.
00035  */
00036 
00037 #ifndef THREAD_DHCPV6_SERVER_H_
00038 #define THREAD_DHCPV6_SERVER_H_
00039 
00040 #include "ns_types.h"
00041 
00042 /**
00043  * Set DHCPV6 server for Thread GP data purpose
00044  *
00045  * \param interface_id Network Interface
00046  * \param prefix_ptr pointer DHCPv6 Server Given Prefix
00047  * \param max_client_cnt Max number of clients
00048  * \param stableData True if data is stable
00049  *
00050  * \return 0, Set OK
00051  * \return <0 Set Not OK
00052  */
00053 int thread_dhcpv6_server_add(int8_t interface_id, uint8_t *prefix_ptr, uint16_t max_client_cnt, bool stableData);
00054 
00055 /**
00056  * Modify dhcp address valid lifetime values default value is 1 day (86400)
00057  *
00058  * \param interface_id Network Interface
00059  * \param prefix_ptr pointer DHCPv6 Server Given Prefix (size must be 16 bytes)
00060  * \param valid_lifetime New valid life value given to new address valid values are (120 - 0xffffffff)
00061  *
00062  * \return 0, ADD OK
00063  * \return <0 Add Not OK
00064  */
00065 int thread_dhcpv6_server_set_lifetime(int8_t interface_id, uint8_t *prefix_ptr, uint32_t valid_lifetime);
00066 
00067 /**
00068  * Modify dhcp maximum client count.
00069  *
00070  * \param interface_id Network Interface
00071  * \param prefix_ptr pointer DHCPv6 Server Given Prefix  (size must be 16 bytes)
00072  * \param max_client_count maximum amount of clients valid values (1 - 0xffffffff)
00073  *
00074  * \return 0, ADD OK
00075  * \return <0 Add Not OK
00076  */
00077 int thread_dhcpv6_server_set_max_client(int8_t interface_id, uint8_t *prefix_ptr, uint32_t max_client_count);
00078 
00079 /**
00080  * Modify dhcp anonymous mode.
00081  *
00082  * \param interface_id Network Interface
00083  * \param prefix_ptr pointer DHCPv6 Server Given Prefix  (size must be 16 bytes)
00084  * \param anonymous true == addressing mode is anonymous, false == addressing mode uses mac address after prefix.
00085  *
00086  * \return 0, ADD OK
00087  * \return <0 Add Not OK
00088  */
00089 int thread_dhcpv6_server_set_anonymous_addressing(int8_t interface_id, uint8_t *prefix_ptr, bool anonymous);
00090 
00091 /**
00092  * Stop DHCPV6 server for Thread GP data purpose
00093  *
00094  * \param interface_id Network Interface
00095  * \param prefix_ptr pointer DHCPv6 Server Given Prefix
00096  *
00097  * \return 0, Stop OK
00098  * \return <0 Stop Not OK
00099  */
00100 int thread_dhcpv6_server_delete(int8_t interface_id, uint8_t *prefix_ptr);
00101 
00102 #endif /* THREAD_DHCPV6_SERVER_H_ */