BootloaderInterface.h

Go to the documentation of this file.

/*
        Aseba - an event-based framework for distributed robot control
        Copyright (C) 2007--2012:
                Stephane Magnenat <stephane at magnenat dot net>
                (http://stephane.magnenat.net)
                and other contributors, see authors.txt for details
        
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU Lesser General Public License as published
        by the Free Software Foundation, version 3 of the License.
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Lesser General Public License for more details.
        
        You should have received a copy of the GNU Lesser General Public License
        along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef ASEBA_BOOTLOADER_INTERFACE_H
#define ASEBA_BOOTLOADER_INTERFACE_H

#include <string>
#include <stdexcept>
#include "../common/types.h"


namespace Dashel
{
        class Stream;
}

namespace Aseba 
{
        // TODO: change API to use HexFile instead of file names
        

        class BootloaderInterface
        {
        public:
                struct Error:public std::runtime_error
                {
                        Error(const std::string& what): std::runtime_error(what) {}
                };
                
        public:
                // main interface
                
                BootloaderInterface(Dashel::Stream* stream, int dest);
                
                int getPageSize() const { return pageSize; }
                
                bool readPage(unsigned pageNumber, uint8* data);
                
                bool readPageSimple(unsigned pageNumber, uint8 * data);
                
                bool writePage(unsigned pageNumber, const uint8 *data, bool simple);
                
                void writeHex(const std::string &fileName, bool reset, bool simple);
                
                void readHex(const std::string &fileName);
                
        protected:
                // reporting function
                
                // progress
                virtual void writePageStart(unsigned pageNumber, const uint8* data, bool simple) {}
                virtual void writePageWaitAck() {}
                virtual void writePageSuccess() {}
                virtual void writePageFailure() {}
                
                virtual void writeHexStart(const std::string &fileName, bool reset, bool simple) {}
                virtual void writeHexEnteringBootloader() {}
                virtual void writeHexGotDescription(unsigned pagesCount) {}
                virtual void writeHexWritten() {}
                virtual void writeHexExitingBootloader() {}
                
                // non-fatal errors
                
                virtual void errorWritePageNonFatal(unsigned pageNumber) {}
                
        protected:
                // member variables
                Dashel::Stream* stream;
                int dest;
                unsigned pageSize;
                unsigned pagesStart;
                unsigned pagesCount;
        };
} // namespace Aseba

#endif // ASEBA_BOOTLOADER_INTERFACE_H