summaryrefslogtreecommitdiffhomepage
path: root/digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h
diff options
context:
space:
mode:
Diffstat (limited to 'digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h')
-rw-r--r--digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h145
1 files changed, 0 insertions, 145 deletions
diff --git a/digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h b/digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h
deleted file mode 100644
index 209bbb27..00000000
--- a/digital/beacon/src/Bitcloud_stack/Components/APS/include/apsmeRemoveDevice.h
+++ /dev/null
@@ -1,145 +0,0 @@
-/**************************************************************************//**
- \file apsmeRemoveDevice.h
-
- \brief Interface of APS Remove Device Service.
-
- \author
- Atmel Corporation: http://www.atmel.com \n
- Support email: avr@atmel.com
-
- Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
- Licensed under Atmel's Limited License Agreement (BitCloudTM).
-
- \internal
- History:
- 2010-11-24 Max Gekk - Created.
- Last change:
- $Id: apsmeRemoveDevice.h 17448 2011-06-09 13:53:59Z ataradov $
- ******************************************************************************/
-#if !defined _APSME_REMOVE_DEVICE_H
-#define _APSME_REMOVE_DEVICE_H
-/**//**
- *
- * The APS-layer provides services that allow a device (for example,
- * a Trust Center) to inform another device (for example, a router)
- * that one of its children should be removed from the network.
- * See ZigBee Specification r19, 4.4.5, page 463.
- *
- **/
-/******************************************************************************
- Includes section
- ******************************************************************************/
-#include <apsCommon.h>
-
-#if defined _SECURITY_
-/******************************************************************************
- Types section
- ******************************************************************************/
-/** Status of creating and sending a remove device command frame. */
-typedef enum
-{
- APS_REMOVE_SUCCESS_STATUS = 0x00,
- APS_REMOVE_NO_SHORT_ADDRESS_STATUS = 0x01,
- APS_REMOVE_SECURITY_FAIL_STATUS = 0x02,
- APS_REMOVE_NOT_SENT_STATUS = 0x03,
- /* These names are deprecated and will be removed. */
- APS_RDR_SUCCESS_STATUS = APS_REMOVE_SUCCESS_STATUS,
- APS_RDR_NO_SHORT_ADDRESS_STATUS = APS_REMOVE_NO_SHORT_ADDRESS_STATUS,
- APS_RDR_SECURITY_FAIL_STATUS = APS_REMOVE_SECURITY_FAIL_STATUS,
- APS_RDR_NOT_SENT_STATUS = APS_REMOVE_NOT_SENT_STATUS
-} APS_RemoveStatus_t;
-
-/** This type is deprecated and will be removed. */
-typedef APS_RemoveStatus_t APS_RdrStatus_t;
-
-/**//**
- * \struct APS_RemoveDeviceConf_t apsmeRemoveDevice.h "aps.h"
- *
- * \brief Confirmation parameters of APSME-REMOVE-DEVICE.request primitive.
- **/
-typedef struct
-{
- /** Status of device removing. */
- APS_RemoveStatus_t status;
-} APS_RemoveDeviceConf_t;
-
-/**//**
- * \struct APS_RemoveDeviceReq_t apsmeRemoveDevice.h "aps.h"
- *
- * \brief Parameters of APSME-REMOVE-DEVICE.request primitive.
- *
- * See ZigBee Specification r19, Table 4.22, page 463.
- **/
-typedef struct
-{
- /** \cond SERVICE_FIELDS **/
- struct
- {
- /** Request to send APS Remove Device command. */
- ApsCommandReq_t commandReq;
- } service;
- /** \endcond **/
-
- /** \ref Endian "[LE]" The extended 64-bit address of the device that is
- * the parent of the child device that is requested to be removed. */
- ExtAddr_t parentAddress;
- /** \ref Endian "[LE]" The extended 64-bit address of the child device
- * that is requested to be removed. */
- ExtAddr_t childAddress;
- /** Confirm primitive as a parameter of the callback function */
- APS_RemoveDeviceConf_t confirm;
- /** Callback function pointer as a handler of corresponding
- * confirm primitive. */
- void (*APS_RemoveDeviceConf)(APS_RemoveDeviceConf_t *conf);
-} APS_RemoveDeviceReq_t;
-
-/**//**
- * \struct APS_RemoveDeviceInd_t apsmeRemoveDevice.h "aps.h"
- *
- * \brief Parameters of APSME-REMOVE-DEVICE.indication primitive.
- *
- * See ZigBee Specification r19, Table 4.23, page 464.
- **/
-typedef struct
-{
- /** \ref Endian "[LE]" The extended 64-bit address of the device requesting
- * that a child device be removed. */
- ExtAddr_t srcAddress;
- /** \ref Endian "[LE]" The extended 64-bit address of the child device
- * that is requested to be removed. */
- ExtAddr_t childAddress;
-} APS_RemoveDeviceInd_t;
-
-/******************************************************************************
- Prototypes section
- ******************************************************************************/
-/**************************************************************************//**
- \brief Request to remove one of children from the network.
-
- For example, a Trust Center can use this primitive to remove a child
- device that fails to authenticate properly. See ZigBee Specification r19,
- 4.4.5.1, page 463.
-
- \param[in] req - pointer to APSME-REMOVE-DEVICE.request's parameters.
-
- \return None.
- ******************************************************************************/
-void APS_RemoveDeviceReq(APS_RemoveDeviceReq_t *req);
-
-/**************************************************************************//**
- \brief Indication about device removing from the network.
-
- The APSME shall generate this primitive when it receives a remove-device
- command frame that is successfully decrypted and authenticated, as specified
- in sub-clause 4.4.1.2 of ZigBee Specification r19.
-
- \param[in] ind - pointer to APSME-REMOVE-DEVICE.indication's parameters.
-
- \return None.
- ******************************************************************************/
-void APS_RemoveDeviceInd(APS_RemoveDeviceInd_t *ind);
-
-#endif /* _SECURITY_ */
-#endif /* _APSME_REMOVE_DEVICE_H */
-/** eof apsmeRemoveDevice.h } */
-