src/base/loader/dtb_object.hh

   1 /*
   2  * Copyright (c) 2013 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Anthony Gutierrez
  29  */
  30
  31 #ifndef __DTB_OBJECT_HH__
  32 #define __DTB_OBJECT_HH__
  33
  34 #include "base/loader/object_file.hh"
  35
  36 /** @file
  37  * This implements an object file format to support loading
  38  * and modifying flattened device tree blobs for use with
  39  * current and future ARM Linux kernels.
  40  */
  41 class DtbObject : public ObjectFile
  42 {
  43     protected:
  44         DtbObject(const std::string &_filename, int _fd,
  45                   size_t _len, uint8_t *_data,
  46                   Arch _arch, OpSys _opSys);
  47
  48         /** Bool marking if this dtb file has replaced the original
  49          *  read in DTB file with a new modified buffer
  50          */
  51         bool fileDataMmapped;
  52
  53     public:
  54         virtual ~DtbObject();
  55
  56         /** Adds the passed in Command Line options for the kernel
  57           * to the proper location in the device tree.
  58           * @param _args command line to append
  59           * @param len length of the command line string
  60           * @return returns true on success, false otherwise
  61           */
  62         bool addBootCmdLine(const char* _args, size_t len);
  63         bool loadGlobalSymbols(SymbolTable *symtab,
  64             Addr addrMask = std::numeric_limits<Addr>::max());
  65         bool loadLocalSymbols(SymbolTable *symtab,
  66             Addr addrMask = std::numeric_limits<Addr>::max());
  67
  68         /** Static function that tries to load file as a
  69           * flattened device tree blob.
  70           * @param fname path to file
  71           * @param fd file descriptor of object file
  72           * @param len length of file
  73           * @param data mmap'ed data buffer containing file contents
  74           * @return ObjectFile representing closest match of file type
  75           */
  76         static ObjectFile *tryFile(const std::string &fname, int fd,
  77                                    size_t len, uint8_t *data);
  78 };
  79
  80 #endif //__DTB_OBJECT_HH__