SerialPacketizer.h

/*
 * Copyright (c) 2013-14, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. 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 _serial_packetizer_h_
#define _serial_packetizer_h_

#include "Packetizer.h"
#include "UartPeripheral.h"
#include "bootloader_common.h"
#include "packet/serial_packet.h"


namespace blfwk
{
// Forward declarations.
class Peripheral;

class SerialPacketizer : public Packetizer
{
public:
    SerialPacketizer(UartPeripheral *peripheral, uint32_t packetTimeoutMs);

    virtual ~SerialPacketizer();

    virtual UartPeripheral *getPeripheral() { return dynamic_cast<UartPeripheral *>(m_peripheral); }
    virtual status_t readPacket(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType);

    virtual status_t writePacket(const uint8_t *packet, uint32_t byteCount, packet_type_t packetType);

    virtual void abortPacket();

    virtual void sync();

    virtual void finalize();

    virtual void enableSimulatorPump() {}
    virtual void pumpSimulator() {}
    virtual void setAborted(bool aborted) {}
    virtual uint32_t getMaxPacketSize();

    void host_delay(uint32_t milliseconds);

    virtual status_t ping(int retries, unsigned int delay, ping_response_t *response, int comSpeed);

protected:
    status_t send_deferred_ack();

    status_t serial_packet_read(uint8_t **packet, uint32_t *packetLength, packet_type_t packetType);

    status_t serial_packet_write(const uint8_t *packet, uint32_t byteCount, packet_type_t packetType);

    void serial_packet_abort();

    uint32_t serial_packet_get_max_packet_size();

    status_t serial_packet_send_sync(uint8_t framingPacketType);

    status_t serial_send_ping_response();

    status_t wait_for_ack_packet();

    status_t read_data_packet(framing_data_packet_t *packet, uint8_t *data, packet_type_t packetType);

    status_t read_start_byte(framing_header_t *header);

    status_t read_header(framing_header_t *header);

    status_t read_length(framing_data_packet_t *packet);

    status_t read_crc16(framing_data_packet_t *packet);

    uint16_t calculate_framing_crc16(framing_data_packet_t *packet, const uint8_t *data);

    serial_data_t m_serialContext;
};

} // namespace blfwk


#endif // _serial_packetizer_h_

// EOF