1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 
  22 /*
  23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
  26  */
  27 
  28 #ifndef _SYS_PSM_COMMON_H
  29 #define _SYS_PSM_COMMON_H
  30 
  31 #include <sys/types.h>
  32 #include <sys/param.h>
  33 #include <sys/cmn_err.h>
  34 
  35 #include <acpica/include/acpi.h>
  36 #include <sys/acpica.h>
  37 
  38 #include <sys/sunddi.h>
  39 #include <sys/ddi.h>
  40 #include <sys/ddi_impldefs.h>
  41 #include <sys/pci.h>
  42 #include <sys/debug.h>
  43 
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47 
  48 
  49 /* private data used in psm_common */
  50 typedef struct acpi_prs_private {
  51         uchar_t         prs_irqflags;
  52         uchar_t         prs_type;
  53 } acpi_prs_private_t;
  54 
  55 
  56 typedef struct acpi_psm_lnk {
  57         ACPI_HANDLE     lnkobj;
  58         acpi_prs_private_t acpi_prs_prv;
  59         uchar_t         device_status;
  60 } acpi_psm_lnk_t;
  61 
  62 typedef void (*intr_exit_fn_t)(int prev_ipl, int irq);
  63 
  64 /*
  65  * status definition for device_status (as returned by _STA)
  66  */
  67 #define STA_PRESENT     0x1
  68 #define STA_ENABLE      0x2
  69 
  70 
  71 /*
  72  * irq_cache_t: Entry for irq cache to map pci bus/dev/ipin or ACPI object
  73  * referencing an interrupt link device the configured irq for the device.
  74  * It is assumed that the acpi object that references the link device is
  75  * the same for all devices that reference the same link device.
  76  */
  77 typedef struct irq_cache {
  78         uchar_t bus, dev;
  79         uchar_t ipin;
  80         uchar_t irq;
  81         iflag_t flags;
  82         ACPI_HANDLE     lnkobj;
  83 } irq_cache_t;
  84 
  85 
  86 typedef struct acpi_irqlist {
  87         acpi_prs_private_t acpi_prs_prv;
  88         iflag_t intr_flags;
  89         uint32_t *irqs;
  90         int num_irqs;
  91         struct acpi_irqlist *next;
  92 } acpi_irqlist_t;
  93 
  94 
  95 #define MAX_ISA_IRQ 15
  96 
  97 #define ELCR_PORT1      0x4D0
  98 #define ELCR_PORT2      0x4D1
  99 
 100 #define ELCR_LEVEL(elcrval, irq)        (elcrval & (0x1 << irq))
 101 #define ELCR_EDGE(elcrval, irq)         ((elcrval & (0x1 << irq)) == 0)
 102 
 103 
 104 #define ACPI_PSM_SUCCESS        0
 105 #define ACPI_PSM_FAILURE        -1
 106 #define ACPI_PSM_PARTIAL        -2
 107 
 108 /* verbose flags definitions */
 109 #define PSM_VERBOSE_IRQ_FLAG                    0x00000001
 110 #define PSM_VERBOSE_POWEROFF_FLAG               0x00000002
 111 #define PSM_VERBOSE_POWEROFF_PAUSE_FLAG         0x00000004
 112 
 113 extern int acpi_psm_init(char *module_name, int verbose_flags);
 114 
 115 extern void build_reserved_irqlist(uchar_t *reserved_irqs_table);
 116 
 117 extern int acpi_translate_pci_irq(dev_info_t *dip, int ipin, int *pci_irqp,
 118     iflag_t *intr_flagp, acpi_psm_lnk_t *acpipsmlnkp);
 119 
 120 extern int acpi_set_irq_resource(acpi_psm_lnk_t *acpipsmlnkp, int irq);
 121 
 122 extern int acpi_get_current_irq_resource(acpi_psm_lnk_t *acpipsmlnkp,
 123     int *pci_irqp, iflag_t *intr_flagp);
 124 
 125 extern int acpi_irqlist_find_irq(acpi_irqlist_t *irqlistp, int irq,
 126     iflag_t *intr_flagp);
 127 
 128 extern void acpi_free_irqlist(acpi_irqlist_t *irqlistp);
 129 
 130 extern int acpi_get_possible_irq_resources(acpi_psm_lnk_t *acpipsmlnkp,
 131     acpi_irqlist_t **irqlistp);
 132 
 133 extern void acpi_new_irq_cache_ent(int bus, int dev, int ipin, int pci_irq,
 134     iflag_t *intr_flagp, acpi_psm_lnk_t *acpipsmlnkp);
 135 
 136 extern int acpi_get_irq_cache_ent(uchar_t bus, uchar_t dev, int ipin,
 137     int *pci_irqp, iflag_t *intr_flagp);
 138 
 139 extern void acpi_restore_link_devices(void);
 140 
 141 extern int acpi_poweroff(void);
 142 
 143 extern void psm_set_elcr(int vecno, int val);
 144 extern int psm_get_elcr(int vecno);
 145 extern intr_exit_fn_t psm_intr_exit_fn(void);
 146 
 147 #ifdef  __cplusplus
 148 }
 149 #endif
 150 
 151 #endif  /* _SYS_PSM_COMMON_H */