text: /*
   * Copyright (c) 2013, Freescale Semiconductor, Inc.
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without modification,
   * are permitted provided that the following conditions are met:
   *
   * o Redistributions of source code must retain the above copyright notice, this list
   *   of conditions and the following disclaimer.
   *
   * o 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.
   *
   * o Neither the name of Freescale Semiconductor, Inc. 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
   */
  #if !defined(__SHUTDOWN_CLEANUP_H__)
  #define __SHUTDOWN_CLEANUP_H__
  
  #include "bootloader_common.h"
  
  //! @addtogroup bl_core
  //! @{
  
  ////////////////////////////////////////////////////////////////////////////////
  // Declarations
  ////////////////////////////////////////////////////////////////////////////////
  
  //! @brief Shutdown types.
  typedef enum _shutdown_types
  {
      kShutdownType_Shutdown = 0,
      kShutdownType_Cleanup = 1,
      kShutdownType_Reset = 2,
  } shutdown_type_t;
  
  ////////////////////////////////////////////////////////////////////////////////
  // API
  ////////////////////////////////////////////////////////////////////////////////
  
  #if defined(__cplusplus)
  extern "C" {
  #endif
  
  /*!
   * @brief Prepare system for exiting the bootloader.
   *
   * Performs any cleanup necessary to restore the system to default state prior to
   * exiting the bootloader. This involves restoring the vector table to default,
   * managing the flash cache, and so on.
   *
   * This routine *must* be invoked prior to permanently exiting the bootloader.
   *
   * @param shutdown Specifies different uses for this function
   *       'kShutdownType_Shutdown' means clean up prior to permanently exiting the bootloader.
   *       'kShutdownType_Cleanup' means only clear (flush) the flash cache
   *       'kShutdownType_Reset' means only shutdown all peripherals.
   */
  void shutdown_cleanup(shutdown_type_t shutdown);
  
  #if defined(__cplusplus)
  }
  #endif
  
  //! @}
  
  #endif // __SHUTDOWN_CLEANUP_H__
  ////////////////////////////////////////////////////////////////////////////////
  // EOF
  ////////////////////////////////////////////////////////////////////////////////
  