utils/zenutils/source/shared/firmware.h

   1 /* zenutils - Utilities for working with creative firmwares.
   2  * Copyright 2007 (c) Rasmus Ry <rasmus.ry{at}gmail.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef ZEN_FIRMWARE_H_INCLUDED
  20 #define ZEN_FIRMWARE_H_INCLUDED
  21
  22 #include <list>
  23 #include <utils.h>
  24
  25 namespace zen {
  26     struct firmware_header_t
  27     {
  28         dword tag;
  29         dword size;
  30     }; //struct firmware_header_t
  31
  32     class firmware_entry
  33     {
  34     public:
  35         firmware_entry(bool big_endian);
  36         firmware_entry(const firmware_entry& copy);
  37         firmware_entry& operator=(const firmware_entry& right);
  38
  39         bool read(std::istream& is);
  40         bool write(std::ostream& os) const;
  41
  42         bool is_big_endian() const;
  43         const firmware_header_t& get_header() const;
  44         firmware_header_t& get_header();
  45         const shared::bytes& get_bytes() const;
  46         shared::bytes& get_bytes();
  47
  48         std::string get_name() const;
  49         std::string get_content_name() const;
  50         size_t get_content_offset() const;
  51         size_t calc_size() const;
  52
  53     protected:
  54         void assign(const firmware_entry& copy);
  55
  56     private:
  57         bool _big_endian;
  58         firmware_header_t _header;
  59         shared::bytes _bytes;
  60     }; //class firmware_entry
  61
  62     typedef std::list<firmware_entry> firmware_entries;
  63
  64     class firmware_archive
  65     {
  66     public:
  67         firmware_archive(bool big_endian);
  68         firmware_archive(const firmware_archive& copy);
  69         firmware_archive& operator=(const firmware_archive& right);
  70
  71         bool read(std::istream& is);
  72         bool write(std::ostream& os) const;
  73
  74         bool is_big_endian() const;
  75         const firmware_entries& get_children() const;
  76         firmware_entries& get_children();
  77         const firmware_entries& get_neighbours() const;
  78         firmware_entries& get_neighbours();
  79         bool is_signed() const;
  80         size_t calc_size() const;
  81
  82     protected:
  83         void assign(const firmware_archive& copy);
  84
  85     private:
  86         firmware_entries _children;
  87         firmware_entries _neighbours;
  88         bool _big_endian;
  89     }; //class firmware_archive
  90 }; //namespace zen
  91
  92 #endif //ZEN_FIRMWARE_ARCHIVE_H_INCLUDED