smp-imps.h

Go to the documentation of this file.

/*
 * Author: Erich Boleyn  <erich@uruk.org>
 *         http://www.uruk.org/~erich/
 *
 * Copyright (c) 1997-2011 Erich Boleyn.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

/*
 *  Header file implementing Intel MultiProcessor Specification (MPS)
 *  version 1.1 and 1.4 SMP hardware control for Intel Architecture CPUs,
 *  with hooks for running correctly on a standard PC without the hardware.
 *
 *  This file was created from information in the Intel MPS version 1.4
 *  document, order number 242016-004, which can be ordered from the
 *  Intel literature center.
 */

/*
 *  This file is based upon code by Eric Boleyn as documented above.  
 *  RTEMS support was added and minimal other changes were made.  
 *  This should make it easier to compare this file with the original 
 *  version.
 *
 *  COPYRIGHT (c) 2011.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#ifndef _SMP_IMPS_H
#define _SMP_IMPS_H

/* make sure "apic.h" is included */
#ifndef _APIC_H
#error          Must include "apic.h" before "smp-imps.h"
#endif  /* !_APIC_H */

/*
 *  Defines used.
 */

#define IMPS_READ(x)    (*((volatile unsigned *) (x)))
#define IMPS_WRITE(x,y) (*((volatile unsigned *) (x)) = (y))

#ifdef IMPS_DEBUG
#define IMPS_DEBUG_PRINT(x)  KERNEL_PRINT(x)
#else  /* !IMPS_DEBUG */
#define IMPS_DEBUG_PRINT(x)
#endif /* !IMPS_DEBUG */

#define IMPS_MAX_CPUS                   APIC_BCAST_ID

#define IMPS_FPS_SIGNATURE      ('_' | ('M'<<8) | ('P'<<16) | ('_'<<24))
#define IMPS_FPS_IMCRP_BIT      0x80
#define IMPS_FPS_DEFAULT_MAX    7

#define IMPS_CTH_SIGNATURE      ('P' | ('C'<<8) | ('M'<<16) | ('P'<<24))

#define         IMPS_FLAG_ENABLED       1
#define IMPS_BCT_PROCESSOR              0
#define         IMPS_CPUFLAG_BOOT       2
#define IMPS_BCT_BUS                    1
#define IMPS_BCT_IOAPIC                 2
#define IMPS_BCT_IO_INTERRUPT           3
#define IMPS_BCT_LOCAL_INTERRUPT        4
#define         IMPS_INT_INT            0
#define         IMPS_INT_NMI            1
#define         IMPS_INT_SMI            2
#define         IMPS_INT_EXTINT         3


/*
 *  Typedefs and data item definitions done here.
 */

typedef struct imps_fps imps_fps;       
typedef struct imps_cth imps_cth;       
typedef struct imps_processor imps_processor;
typedef struct imps_bus imps_bus;
typedef struct imps_ioapic imps_ioapic;
typedef struct imps_interrupt imps_interrupt;


/*
 *  Data structures defined here
 */

struct imps_fps
{
  unsigned sig;
  imps_cth *cth_ptr;
  unsigned char length;
  unsigned char spec_rev;
  unsigned char checksum;
  unsigned char feature_info[5];
};

struct imps_cth
{
  unsigned sig;
  unsigned short base_length;
  unsigned char spec_rev;
  unsigned char checksum;
  char oem_id[8];
  char prod_id[12];
  unsigned oem_table_ptr;
  unsigned short oem_table_size;
  unsigned short entry_count;
  unsigned lapic_addr;
  unsigned short extended_length;
  unsigned char extended_checksum;
        char reserved[1];
};

struct imps_processor
{
  unsigned char type;                     
  unsigned char apic_id;
  unsigned char apic_ver;
  unsigned char flags;
  unsigned signature;
  unsigned features;
  char reserved[8];
};

struct imps_bus
{
  unsigned char type;                     
  unsigned char id;
  char bus_type[6];
};

struct imps_ioapic
{
  unsigned char type;                     
  unsigned char id;
  unsigned char ver;
  unsigned char flags;
  unsigned addr;
};

struct imps_interrupt
{
  unsigned char type;                     
  unsigned char int_type;
  unsigned short flags;
  unsigned char source_bus_id;
  unsigned char source_bus_irq;
  unsigned char dest_apic_id;
  unsigned char dest_apic_intin;
};

/*
 *  Exported globals here.
 */

extern unsigned char imps_cpu_apic_map[IMPS_MAX_CPUS];
extern unsigned char imps_apic_cpu_map[IMPS_MAX_CPUS];

extern char _binary_appstart_bin_start[];
extern char _binary_appstart_bin_size[];

extern unsigned imps_lapic_addr;

/*
 *  Defines that use variables
 */
#define IMPS_LAPIC_READ(x)  (*((volatile unsigned *) (imps_lapic_addr+(x))))
#define IMPS_LAPIC_WRITE(x, y)   \
   (*((volatile unsigned *) (imps_lapic_addr+(x))) = (y))

#endif  /* !_SMP_IMPS_H */