/*=============================================================================
  Readme file for setting up custom splash logo in UEFI.

  Copyright (c) 2016 Qualcomm Technologies, Inc. 
  All rights reserved.
  Confidential and Proprietary - Qualcomm Technologies, Inc.

=============================================================================*/

------------------------
Supported Image formats:
------------------------
    8-bit BMP
    24-bit BMP
    32-bit BMP

------------------
Target OS: Windows
------------------
    Copy custom logos to ACPI Partition
    
------------------------
Target OS: Linux/Android
------------------------
 
    Custom logo should be packaged in the main UEFI FV as 'logo1.bmp' under:
    boot_images/QcomPkg/Logo/LA


    -----------------------------
    Alternative: Splash partition
    -----------------------------

    !!!!!!!!!!
    !! NOTE !! This is not recomended as splash partition is not authenticated at boot.
    !!!!!!!!!!

    Custom logo may also be packaged and programmed onto the splash partition.
    However, this presents a secuirty hole as the splash partition is not
    authenticated during boot.
    
    =========================
    Host Setup \ Requirements
    =========================
    1. Linux or Windows host
    2. Python 2.7

    =================================
    Prepare and load logo onto target
    =================================

    Script: boot_images\QcomPkg\Tools\splash_logo_gen.py

    Steps:

    1. Enable the use of splash partition in boot_images\QcomPkg\Msm8998Pkg\LA\uefiplat.cfg
        Set EnableSecurityHoleForSplashPartition = 0x1 

    2. Generate splash partition image for custom logo
        Command: python splash_logo_gen.py <bmpfile>
        
        => Ex: python splash_logo_gen.py qualcomm_24b.bmp
        => splash.img is created in the current folder

    3. Flash splash partition onto target using fastboot
        Command: fastboot flash splash splash.img

    4. Reboot target.	
        Custom logo should be displayed on startup.

