/*
 *    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.
 */

/**
 * @file
 *   This file includes definitions for an HDLC-lite encoder and decoder.
 */

#pragma once

enum
{
    HdlcXOn            = 0x11,
    HdlcXOff           = 0x13,
    HdlcFlagSequence   = 0x7e,  ///< HDLC Flag value
    HdlcEscapeSequence = 0x7d,  ///< HDLC Escape value
    HdlcSpecial        = 0xF8
};

ULONG
HdlcComputeEncodedLength(
    _In_reads_bytes_(DecodedBufferLength) 
         PUCHAR         DecodedBuffer,
    _In_ ULONG          DecodedBufferLength
    );

_Success_(return == true)
bool
HdlcEncodeBuffer(
    _In_reads_bytes_(DecodedBufferLength) 
         PUCHAR         DecodedBuffer,
    _In_ ULONG          DecodedBufferLength,
    _Out_writes_bytes_(EncodedBufferLength) 
         PUCHAR         EncodedBuffer,
    _In_ ULONG          EncodedBufferLength
    );

_Success_(return == true)
bool
HdlcDecodeBuffer(
    _In_reads_bytes_(*EncodedBufferLength) 
            PUCHAR      EncodedBuffer,
    _Inout_ PULONG      EncodedBufferLength,
    _Inout_ PULONG      DecodedBufferLength,
    _Out_writes_bytes_opt_(*DecodedBufferLength) 
            PUCHAR      DecodedBuffer,
    _Out_   bool*       IsGood
    );