BIOS multiprocessor API implementation. More...

#include <registers.h>
#include <librm.h>
#include <ipxe/uaccess.h>
#include <ipxe/timer.h>
#include <ipxe/msr.h>
#include <ipxe/mp.h>

Macros
#define	MSR_APIC_BASE 0x0000001b
	Local APIC base address MSR.
#define	MSR_APIC_BASE_X2APIC 0x400
	Local APIC is in x2APIC mode.
#define	MSR_APIC_BASE_MASK ( ~0xfffULL )
	Local APIC base address mask.
#define	APIC_ICR 0x0300
	Interrupt command register.
#define	MSR_X2APIC_ICR 0x830
	Interrupt command register (x2APIC)
#define	APIC_ICR_ALL_NOT_SELF 0x000c0000
	Interrupt command register: send to all excluding self.
#define	APIC_ICR_LEVEL 0x00008000
	Interrupt command register: level mode.
#define	APIC_ICR_LEVEL_ASSERT 0x00004000
	Interrupt command register: level asserted.
#define	APIC_ICR_INIT 0x00000500
	Interrupt command register: INIT.
#define	APIC_ICR_SIPI(vector)
	Interrupt command register: SIPI.
#define	IPI_WAIT_MS 10
	Time to wait for an IPI to complete.
#define	SIPI_VECTOR 0x08
	Startup IPI vector.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void __asmcall	mp_jump (mp_addr_t func, mp_addr_t opaque)
	Protected-mode startup IPI handler.
static void	bios_mp_exec_boot (mp_func_t func, void *opaque)
	Execute a multiprocessor function on the boot processor.
static void	bios_mp_ipi (void *apic, int x2apic, uint32_t icr)
	Send an interprocessor interrupt.
static void	bios_mp_start_all (mp_func_t func, void *opaque)
	Start a multiprocessor function on all application processors.
	PROVIDE_MPAPI_INLINE (pcbios, mp_address)
	PROVIDE_MPAPI (pcbios, mp_exec_boot, bios_mp_exec_boot)
	PROVIDE_MPAPI (pcbios, mp_start_all, bios_mp_start_all)

Detailed Description

BIOS multiprocessor API implementation.

Definition in file bios_mp.c.

Macro Definition Documentation

◆ MSR_APIC_BASE

#define MSR_APIC_BASE 0x0000001b

Local APIC base address MSR.

Definition at line 40 of file bios_mp.c.

Referenced by bios_mp_ipi(), and bios_mp_start_all().

◆ MSR_APIC_BASE_X2APIC

#define MSR_APIC_BASE_X2APIC 0x400

Local APIC is in x2APIC mode.

Definition at line 43 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ MSR_APIC_BASE_MASK

#define MSR_APIC_BASE_MASK ( ~0xfffULL )

Local APIC base address mask.

Definition at line 46 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ APIC_ICR

#define APIC_ICR 0x0300

Interrupt command register.

Definition at line 49 of file bios_mp.c.

Referenced by bios_mp_ipi().

◆ MSR_X2APIC_ICR

#define MSR_X2APIC_ICR 0x830

Interrupt command register (x2APIC)

Definition at line 52 of file bios_mp.c.

Referenced by bios_mp_ipi().

◆ APIC_ICR_ALL_NOT_SELF

#define APIC_ICR_ALL_NOT_SELF 0x000c0000

Interrupt command register: send to all excluding self.

Definition at line 55 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ APIC_ICR_LEVEL

#define APIC_ICR_LEVEL 0x00008000

Interrupt command register: level mode.

Definition at line 58 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ APIC_ICR_LEVEL_ASSERT

#define APIC_ICR_LEVEL_ASSERT 0x00004000

Interrupt command register: level asserted.

Definition at line 61 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ APIC_ICR_INIT

#define APIC_ICR_INIT 0x00000500

Interrupt command register: INIT.

Definition at line 64 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ APIC_ICR_SIPI

#define APIC_ICR_SIPI ( vector )

Value:

( 0x00000600 | (vector) )

vector

uint32_t vector

MSI-X vector.

Definition ena.h:9

Interrupt command register: SIPI.

Definition at line 67 of file bios_mp.c.

Referenced by bios_mp_start_all().

◆ IPI_WAIT_MS

#define IPI_WAIT_MS 10

Time to wait for an IPI to complete.

Definition at line 70 of file bios_mp.c.

Referenced by bios_mp_ipi().

◆ SIPI_VECTOR

#define SIPI_VECTOR 0x08

Startup IPI vector.

The real-mode startup IPI code must be copied to a page boundary in base memory. We fairly arbitrarily choose to place this at 0x8000.

Definition at line 78 of file bios_mp.c.

Referenced by bios_mp_start_all().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ mp_jump()

void __asmcall mp_jump	(	mp_addr_t	func,
		mp_addr_t	opaque )

extern

Protected-mode startup IPI handler.

References __asmcall.

Referenced by bios_mp_start_all().

◆ bios_mp_exec_boot()

void bios_mp_exec_boot	(	mp_func_t	func,
		void *	opaque )

static

Execute a multiprocessor function on the boot processor.

Parameters

func	Multiprocessor function
opaque	Opaque data pointer

Definition at line 89 of file bios_mp.c.

                                                               {
 
        /* Call multiprocessor function with physical addressing */
        __asm__ __volatile__ ( PHYS_CODE ( "pushl %k2\n\t"
                                           "pushl %k1\n\t"
                                           "call *%k0\n\t"
                                           "addl $8, %%esp\n\t" )
                               : : "R" ( mp_address ( mp_call ) ),
                                   "R" ( mp_address ( func ) ),
                                   "R" ( mp_address ( opaque ) ) );
}

References __asm__(), __volatile__(), mp_address(), mp_call(), and PHYS_CODE.

Referenced by PROVIDE_MPAPI().

◆ bios_mp_ipi()

void bios_mp_ipi	(	void *	apic,
		int	x2apic,
		uint32_t	icr )

static

Send an interprocessor interrupt.

Parameters

apic	APIC base address
x2apic	x2APIC mode enabled
icr	Interrupt control register value

Definition at line 108 of file bios_mp.c.

                                                                 {
 
        /* Write ICR according to APIC/x2APIC mode */
        DBGC ( MSR_APIC_BASE, "BIOSMP sending IPI %#08x\n", icr );
        if ( x2apic ) {
                wrmsr ( MSR_X2APIC_ICR, icr );
        } else {
                writel ( icr, ( apic + APIC_ICR ) );
        }
 
        /* Allow plenty of time for delivery to complete */
        mdelay ( IPI_WAIT_MS );
}

References APIC_ICR, DBGC, IPI_WAIT_MS, mdelay(), MSR_APIC_BASE, MSR_X2APIC_ICR, and writel.

Referenced by bios_mp_start_all().

◆ bios_mp_start_all()

void bios_mp_start_all	(	mp_func_t	func,
		void *	opaque )

static

Start a multiprocessor function on all application processors.

Parameters

func	Multiprocessor function
opaque	Opaque data pointer

Definition at line 128 of file bios_mp.c.

                                                               {
        struct i386_regs regs;
        uint64_t base;
        uint32_t ipi;
        void *apic;
        int x2apic;
 
        /* Prepare SIPI handler */
        regs.eax = mp_address ( func );
        regs.edx = mp_address ( opaque );
        setup_sipi ( SIPI_VECTOR, virt_to_phys ( mp_jump ), &regs );
 
        /* Get local APIC base address and mode */
        base = rdmsr ( MSR_APIC_BASE );
        x2apic = ( base & MSR_APIC_BASE_X2APIC );
        DBGC ( MSR_APIC_BASE, "BIOSMP local %sAPIC base %#llx\n",
               ( x2apic ? "x2" : "" ), ( ( unsigned long long ) base ) );
 
        /* Map local APIC */
        apic = ioremap ( ( base & MSR_APIC_BASE_MASK ), PAGE_SIZE );
        if ( ! apic )
                goto err_ioremap;
 
        /* Assert INIT IPI */
        ipi = ( APIC_ICR_ALL_NOT_SELF | APIC_ICR_LEVEL |
                APIC_ICR_LEVEL_ASSERT | APIC_ICR_INIT );
        bios_mp_ipi ( apic, x2apic, ipi );
 
        /* Clear INIT IPI */
        ipi &= ~APIC_ICR_LEVEL_ASSERT;
        bios_mp_ipi ( apic, x2apic, ipi );
 
        /* Send SIPI */
        ipi = ( APIC_ICR_ALL_NOT_SELF | APIC_ICR_SIPI ( SIPI_VECTOR ) );
        bios_mp_ipi ( apic, x2apic, ipi );
 
        iounmap ( apic );
 err_ioremap:
        /* No way to handle errors: caller must check that
         * multiprocessor function executed as expected.
         */
        return;
}

References APIC_ICR_ALL_NOT_SELF, APIC_ICR_INIT, APIC_ICR_LEVEL, APIC_ICR_LEVEL_ASSERT, APIC_ICR_SIPI, base, bios_mp_ipi(), DBGC, ioremap(), iounmap(), mp_address(), mp_jump(), MSR_APIC_BASE, MSR_APIC_BASE_MASK, MSR_APIC_BASE_X2APIC, PAGE_SIZE, regs, setup_sipi(), and SIPI_VECTOR.

Referenced by PROVIDE_MPAPI().

◆ PROVIDE_MPAPI_INLINE()

PROVIDE_MPAPI_INLINE	(	pcbios	,
		mp_address	)

References mp_address().

◆ PROVIDE_MPAPI() [1/2]

PROVIDE_MPAPI	(	pcbios	,
		mp_exec_boot	,
		bios_mp_exec_boot	)

References bios_mp_exec_boot(), and mp_exec_boot().

◆ PROVIDE_MPAPI() [2/2]

PROVIDE_MPAPI	(	pcbios	,
		mp_start_all	,
		bios_mp_start_all	)

References bios_mp_start_all(), and mp_start_all().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ MSR_APIC_BASE

◆ MSR_APIC_BASE_X2APIC

◆ MSR_APIC_BASE_MASK

◆ APIC_ICR

◆ MSR_X2APIC_ICR

◆ APIC_ICR_ALL_NOT_SELF

◆ APIC_ICR_LEVEL

◆ APIC_ICR_LEVEL_ASSERT

◆ APIC_ICR_INIT

◆ APIC_ICR_SIPI

◆ IPI_WAIT_MS

◆ SIPI_VECTOR

Function Documentation

◆ FILE_LICENCE()

◆ mp_jump()

◆ bios_mp_exec_boot()

◆ bios_mp_ipi()

◆ bios_mp_start_all()

◆ PROVIDE_MPAPI_INLINE()

◆ PROVIDE_MPAPI() [1/2]

◆ PROVIDE_MPAPI() [2/2]