bossa 2.3.0

Rust cxx wrapper around BOSSA SAM-BA library
Documentation
///////////////////////////////////////////////////////////////////////////////
// BOSSA
//
// Copyright (c) 2011-2018, ShumaTech
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * 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.
//     * Neither the name of the <organization> 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 <COPYRIGHT HOLDER> 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 _COMMAND_H
#define _COMMAND_H

#include <stdint.h>

#include "Shell.h"
#include "Samba.h"
#include "PortFactory.h"
#include "Device.h"
#include "Flasher.h"

class CommandObserver : public FlasherObserver
{
public:
    CommandObserver() : _lastTicks(-1) {}
    virtual ~CommandObserver() {}
    
    virtual void onStatus(const char *message, ...);
    virtual void onProgress(int num, int div);
private:
    int _lastTicks;
};

class Command
{
public:
    Command(const char* name, const char* help, const char* usage);
    virtual ~Command() {}

    virtual void invoke(char* argv[], int argc) = 0;
    const char* name() { return _name; };
    const char* help() { return _help; };
    const char* usage() { return _usage; };

    static void setShell(Shell* shell) { _shell = shell; }
    static void disconnect();

    bool operator < (const Command& rhs);

protected:
    static Shell* _shell;
    static Samba _samba;
    static PortFactory _portFactory;
    static Device _device;
    static Device::FlashPtr& _flash;
    static Flasher _flasher;
    static CommandObserver _observer;
    static bool _connected;

    bool error(const char* fmt, ...);
    bool argNum(int argc, int num);
    bool argRange(int argc, int min, int max);
    bool argUint32(const char* arg, uint32_t* value);
    bool argBool(const char* arg, bool* value);
    bool argState(const char* arg, bool* value);
    
    bool createDevice();
    bool connected();
    bool flashable();

    void hexdump(uint32_t addr, uint8_t *buf, size_t count);
    const char* binstr(uint32_t value, int bits, char low = '0', char high = '1');

private:
    const char* _name;
    const char* _help;
    const char* _usage;
};

class CommandBod : public Command
{
public:
    CommandBod();
    virtual void invoke(char* argv[], int argc);
};

class CommandBootf : public Command
{
public:
    CommandBootf();
    virtual void invoke(char* argv[], int argc);
};

class CommandBor : public Command
{
public:
    CommandBor();
    virtual void invoke(char* argv[], int argc);
};

class CommandConnect : public Command
{
public:
    CommandConnect();
    virtual void invoke(char* argv[], int argc);
};

class CommandDebug : public Command
{
public:
    CommandDebug();
    virtual void invoke(char* argv[], int argc);
};

class CommandDump : public Command
{
public:
    CommandDump();
    virtual void invoke(char* argv[], int argc);
};
class CommandErase : public Command
{
public:
    CommandErase();
    virtual void invoke(char* argv[], int argc);
};

class CommandExit : public Command
{
public:
    CommandExit();
    virtual void invoke(char* argv[], int argc);
};

class CommandGo : public Command
{
public:
    CommandGo();
    virtual void invoke(char* argv[], int argc);
};

class CommandHelp : public Command
{
public:
    CommandHelp();
    virtual void invoke(char* argv[], int argc);
};

class CommandHistory : public Command
{
public:
    CommandHistory();
    virtual void invoke(char* argv[], int argc);
};

class CommandInfo : public Command
{
public:
    CommandInfo();
    virtual void invoke(char* argv[], int argc);
};

class CommandLock : public Command
{
public:
    CommandLock();
    virtual void invoke(char* argv[], int argc);
};

class CommandMrb : public Command
{
public:
    CommandMrb();
    virtual void invoke(char* argv[], int argc);
};

class CommandMrf : public Command
{
public:
    CommandMrf();
    virtual void invoke(char* argv[], int argc);
};

class CommandMrw : public Command
{
public:
    CommandMrw();
    virtual void invoke(char* argv[], int argc);
};

class CommandMwb : public Command
{
public:
    CommandMwb();
    virtual void invoke(char* argv[], int argc);
};

class CommandMwf : public Command
{
public:
    CommandMwf();
    virtual void invoke(char* argv[], int argc);
};

class CommandMww : public Command
{
public:
    CommandMww();
    virtual void invoke(char* argv[], int argc);
};

class CommandPio : public Command
{
public:
    CommandPio();
    virtual void invoke(char* argv[], int argc);
};

class CommandRead : public Command
{
public:
    CommandRead();
    virtual void invoke(char* argv[], int argc);
};

class CommandSecurity : public Command
{
public:
    CommandSecurity();
    virtual void invoke(char* argv[], int argc);
};

class CommandUnlock : public Command
{
public:
    CommandUnlock();
    virtual void invoke(char* argv[], int argc);
};

class CommandVerify : public Command
{
public:
    CommandVerify();
    virtual void invoke(char* argv[], int argc);
};

class CommandWrite : public Command
{
public:
    CommandWrite();
    virtual void invoke(char* argv[], int argc);
};

class CommandReset : public Command
{
public:
    CommandReset();
    virtual void invoke(char* argv[], int argc);
};

class CommandOptions : public Command
{
public:
    CommandOptions();
    virtual void invoke(char* argv[], int argc);
};

#endif // _COMMAND_H