ymodem_rx.h

Go to the documentation of this file.

/*
This program is distributed under the terms of the 'MIT license'. The text
of this licence follows...

Copyright (c) 2006 J.D.Medhurst (a.k.a. Tixy)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#include "ymodem.h"

class YModemRx : public YModem
    {
public:
    YModemRx(SerialPort& port);

    class OutStream
        {
    public:
        virtual int Open(const char* fileName, size_t size) =0;

        virtual int Out(const uint8_t* data, size_t size) =0;

        inline virtual ~OutStream() {}
        };

    int ReceiveX(OutStream& out, unsigned timeout, bool useCrc);

    int ReceiveY(OutStream& out, unsigned timeout, bool gMode);

    enum RxError
        {
        ErrorOutputStreamError              = -400, 
        ErrorTransmitterNotBehaving         = -401, 
        ErrorTranferTerminatedByTransmitter = -402, 
        ErrorReceivedBadData                = -403, 
        ErrorMultipleFilesSent              = -404  
        };

private:
    class OutBlock0 : public OutStream
        {
    public:
        OutBlock0();
        int Open(const char* fileName, size_t size);
        int Out(const uint8_t* data, size_t size);
        int Parse(const char*& fileName, size_t& fileSize);
    private:
        uint8_t Buffer[1024];   
        size_t Size;            
        };

    int ReceiveInitialise(OutStream& out,unsigned timeout);
    int ReceiveBlock(OutStream& out);
    int OutChar(uint8_t c);
private:
    size_t BlockNumber;
    bool ExpectCRC;     
    bool SendBlockACK;
    uint8_t ModeChar;
    uint8_t NAKChar;
    };