src/base/loader/dtb_file.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
  29 #ifndef __BASE_LOADER_DTB_FILE_HH__
  30 #define __BASE_LOADER_DTB_FILE_HH__
  31
  32 #include "base/loader/image_file.hh"
  33
  34 namespace Loader
  35 {
  36
  37 /** @file
  38  * This implements an image file format to support loading
  39  * and modifying flattened device tree blobs for use with
  40  * current and future ARM Linux kernels.
  41  */
  42 class DtbFile : public ImageFile
  43 {
  44   protected:
  45     /** Bool marking if this dtb file has replaced the original
  46      *  read in DTB file with a new modified buffer
  47      */
  48     bool fileDataMmapped;
  49     uint8_t *fileData = nullptr;
  50     size_t length = 0;
  51
  52   public:
  53     DtbFile(const std::string &name);
  54     ~DtbFile();
  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
  64     /** Parse the DTB file enough to find the provided release
  65      * address and return it.
  66      * @return release address for SMP boot
  67      */
  68     Addr findReleaseAddr();
  69
  70     MemoryImage buildImage() const override;
  71 };
  72
  73 } // namespace Loader
  74
  75 #endif //__BASE_LOADER_DTB_FILE_HH__