icmp6.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OPENTHREAD_ICMP6_H_
#define OPENTHREAD_ICMP6_H_

#include <openthread/message.h>
#include <openthread/types.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum otIcmp6Type
{
    OT_ICMP6_TYPE_DST_UNREACH  = 1,     
    OT_ICMP6_TYPE_ECHO_REQUEST = 128,   
    OT_ICMP6_TYPE_ECHO_REPLY   = 129,   
} otIcmp6Type;

typedef enum otIcmp6Code
{
    OT_ICMP6_CODE_DST_UNREACH_NO_ROUTE = 0,  
} otIcmp6Code;

#define OT_ICMP6_HEADER_DATA_SIZE  4   


OT_TOOL_PACKED_BEGIN
struct otIcmp6Header
{
    uint8_t      mType;      
    uint8_t      mCode;      
    uint16_t     mChecksum;  
    union OT_TOOL_PACKED_FIELD
    {
        uint8_t  m8[OT_ICMP6_HEADER_DATA_SIZE / sizeof(uint8_t)];
        uint16_t m16[OT_ICMP6_HEADER_DATA_SIZE / sizeof(uint16_t)];
        uint32_t m32[OT_ICMP6_HEADER_DATA_SIZE / sizeof(uint32_t)];
    } mData;  
} OT_TOOL_PACKED_END;

typedef struct otIcmp6Header otIcmp6Header;

typedef void (*otIcmp6ReceiveCallback)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo,
                                       const otIcmp6Header *aIcmpHeader);

typedef struct otIcmp6Handler
{
    otIcmp6ReceiveCallback  mReceiveCallback;  
    void                   *mContext;          
    struct otIcmp6Handler  *mNext;             
} otIcmp6Handler;

bool otIcmp6IsEchoEnabled(otInstance *aInstance);

void otIcmp6SetEchoEnabled(otInstance *aInstance, bool aEnabled);

otError otIcmp6RegisterHandler(otInstance *aInstance, otIcmp6Handler *aHandler);

otError otIcmp6SendEchoRequest(otInstance *aInstance, otMessage *aMessage,
                               const otMessageInfo *aMessageInfo, uint16_t aIdentifier);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // OPENTHREAD_ICMP6_H_