Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
mbed-os/features/nanostack/sal-stack-nanostack/nanostack/net_address_extension.h@0:8fdf9a60065b, 2018-10-10 (annotated)
- Committer:
- kadonotakashi
- Date:
- Wed Oct 10 00:33:53 2018 +0000
- Revision:
- 0:8fdf9a60065b
how to make mbed librry
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| kadonotakashi | 0:8fdf9a60065b | 1 | /* |
| kadonotakashi | 0:8fdf9a60065b | 2 | * Copyright (c) 2013-2017, Arm Limited and affiliates. |
| kadonotakashi | 0:8fdf9a60065b | 3 | * SPDX-License-Identifier: Apache-2.0 |
| kadonotakashi | 0:8fdf9a60065b | 4 | * |
| kadonotakashi | 0:8fdf9a60065b | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| kadonotakashi | 0:8fdf9a60065b | 6 | * you may not use this file except in compliance with the License. |
| kadonotakashi | 0:8fdf9a60065b | 7 | * You may obtain a copy of the License at |
| kadonotakashi | 0:8fdf9a60065b | 8 | * |
| kadonotakashi | 0:8fdf9a60065b | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| kadonotakashi | 0:8fdf9a60065b | 10 | * |
| kadonotakashi | 0:8fdf9a60065b | 11 | * Unless required by applicable law or agreed to in writing, software |
| kadonotakashi | 0:8fdf9a60065b | 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| kadonotakashi | 0:8fdf9a60065b | 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| kadonotakashi | 0:8fdf9a60065b | 14 | * See the License for the specific language governing permissions and |
| kadonotakashi | 0:8fdf9a60065b | 15 | * limitations under the License. |
| kadonotakashi | 0:8fdf9a60065b | 16 | */ |
| kadonotakashi | 0:8fdf9a60065b | 17 | #ifndef _NET_ADDRESS_EXTENSION_H |
| kadonotakashi | 0:8fdf9a60065b | 18 | #define _NET_ADDRESS_EXTENSION_H |
| kadonotakashi | 0:8fdf9a60065b | 19 | |
| kadonotakashi | 0:8fdf9a60065b | 20 | #include "ns_types.h" |
| kadonotakashi | 0:8fdf9a60065b | 21 | |
| kadonotakashi | 0:8fdf9a60065b | 22 | #ifdef __cplusplus |
| kadonotakashi | 0:8fdf9a60065b | 23 | extern "C" { |
| kadonotakashi | 0:8fdf9a60065b | 24 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 25 | |
| kadonotakashi | 0:8fdf9a60065b | 26 | /** |
| kadonotakashi | 0:8fdf9a60065b | 27 | * \file net_address_extension.h |
| kadonotakashi | 0:8fdf9a60065b | 28 | * \brief API for setting up link layer short address manually. |
| kadonotakashi | 0:8fdf9a60065b | 29 | * |
| kadonotakashi | 0:8fdf9a60065b | 30 | * \section set-addr Setting short address |
| kadonotakashi | 0:8fdf9a60065b | 31 | * - net_ext_set_short_address_from_app(), Sets up a user-specified short address and enables or disables DAD. |
| kadonotakashi | 0:8fdf9a60065b | 32 | * |
| kadonotakashi | 0:8fdf9a60065b | 33 | * NOTE: In case of duplication of address and DAD (duplicate address detection) enabled, i.e., DAD=1, the stack |
| kadonotakashi | 0:8fdf9a60065b | 34 | * generates a short address dynamically. |
| kadonotakashi | 0:8fdf9a60065b | 35 | * |
| kadonotakashi | 0:8fdf9a60065b | 36 | * - \section reset-addr Resetting short address. |
| kadonotakashi | 0:8fdf9a60065b | 37 | * - net_ext_reset_short_address_from_app(), Clears any user-specified static or default short address and enables dynamic generation. |
| kadonotakashi | 0:8fdf9a60065b | 38 | */ |
| kadonotakashi | 0:8fdf9a60065b | 39 | |
| kadonotakashi | 0:8fdf9a60065b | 40 | /** |
| kadonotakashi | 0:8fdf9a60065b | 41 | * \brief Function to set short address from application. |
| kadonotakashi | 0:8fdf9a60065b | 42 | * |
| kadonotakashi | 0:8fdf9a60065b | 43 | * \param short_id 16-bit user-specified short address. |
| kadonotakashi | 0:8fdf9a60065b | 44 | * \param generate_dynamical_at_DAD Set 1 if stack is allowed to generate new short address dynamically in case of DAD, otherwise set 0. |
| kadonotakashi | 0:8fdf9a60065b | 45 | * |
| kadonotakashi | 0:8fdf9a60065b | 46 | * \return 0xfffe or 0xffff when the stack does not use any short address. |
| kadonotakashi | 0:8fdf9a60065b | 47 | */ |
| kadonotakashi | 0:8fdf9a60065b | 48 | |
| kadonotakashi | 0:8fdf9a60065b | 49 | extern void net_ext_set_short_address_from_app(uint16_t short_id, uint8_t generate_dynamical_at_DAD); |
| kadonotakashi | 0:8fdf9a60065b | 50 | |
| kadonotakashi | 0:8fdf9a60065b | 51 | /** |
| kadonotakashi | 0:8fdf9a60065b | 52 | * \brief Clears currently used static or default short address and enables dynamic generation of new short address. |
| kadonotakashi | 0:8fdf9a60065b | 53 | */ |
| kadonotakashi | 0:8fdf9a60065b | 54 | extern void net_ext_reset_short_address_from_app(void); |
| kadonotakashi | 0:8fdf9a60065b | 55 | |
| kadonotakashi | 0:8fdf9a60065b | 56 | /** |
| kadonotakashi | 0:8fdf9a60065b | 57 | * \brief Get current short address used in the network for this particular interface. |
| kadonotakashi | 0:8fdf9a60065b | 58 | * |
| kadonotakashi | 0:8fdf9a60065b | 59 | * \return 0xfffe or 0xffff if stack is not using any short address. |
| kadonotakashi | 0:8fdf9a60065b | 60 | */ |
| kadonotakashi | 0:8fdf9a60065b | 61 | extern uint16_t net_ext_get_short_address(void); |
| kadonotakashi | 0:8fdf9a60065b | 62 | #ifdef __cplusplus |
| kadonotakashi | 0:8fdf9a60065b | 63 | } |
| kadonotakashi | 0:8fdf9a60065b | 64 | #endif |
| kadonotakashi | 0:8fdf9a60065b | 65 | #endif |