MdePkg/Library/BaseLib/x86EnablePaging64.c

   1 /** @file
   2   IA-32/x64 AsmEnablePaging64()
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  x86EnablePaging64.c
  14
  15 **/
  16
  17 //
  18 // Include common header file for this module.
  19 //
  20 #include "CommonHeader.h"
  21
  22 #include "BaseLibInternals.h"
  23
  24 /**
  25   Enables the 64-bit paging mode on the CPU.
  26
  27   Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
  28   must be properly initialized prior to calling this service. This function
  29   assumes the current execution mode is 32-bit protected mode with flat
  30   descriptors. This function is only available on IA-32. After the 64-bit
  31   paging mode is enabled, control is transferred to the function specified by
  32   EntryPoint using the new stack specified by NewStack and passing in the
  33   parameters specified by Context1 and Context2. Context1 and Context2 are
  34   optional and may be 0. The function EntryPoint must never return.
  35
  36   If the current execution mode is not 32-bit protected mode with flat
  37   descriptors, then ASSERT().
  38   If EntryPoint is 0, then ASSERT().
  39   If NewStack is 0, then ASSERT().
  40
  41   @param  Cs          The 16-bit selector to load in the CS before EntryPoint
  42                       is called. The descriptor in the GDT that this selector
  43                       references must be setup for long mode.
  44   @param  EntryPoint  The 64-bit virtual address of the function to call with
  45                       the new stack after paging is enabled.
  46   @param  Context1    The 64-bit virtual address of the context to pass into
  47                       the EntryPoint function as the first parameter after
  48                       paging is enabled.
  49   @param  Context2    The 64-bit virtual address of the context to pass into
  50                       the EntryPoint function as the second parameter after
  51                       paging is enabled.
  52   @param  NewStack    The 64-bit virtual address of the new stack to use for
  53                       the EntryPoint function after paging is enabled.
  54
  55 **/
  56 VOID
  57 EFIAPI
  58 AsmEnablePaging64 (
  59   IN      UINT16                    Cs,
  60   IN      UINT64                    EntryPoint,
  61   IN      UINT64                    Context1,  OPTIONAL
  62   IN      UINT64                    Context2,  OPTIONAL
  63   IN      UINT64                    NewStack
  64   )
  65 {
  66   ASSERT (EntryPoint != 0);
  67   ASSERT (NewStack != 0);
  68   InternalX86EnablePaging64 (Cs, EntryPoint, Context1, Context2, NewStack);
  69 }