9bf4c9c1b0
- Add 3 new functions to the pci_if interface along with suitable wrappers
to provide the device driver visible API:
- pci_alloc_msi(dev, int *count) backed by PCI_ALLOC_MSI(). '*count'
here is an in and out parameter. The driver stores the desired number
of messages in '*count' before calling the function. On success,
'*count' holds the number of messages allocated to the device. Also on
success, the driver can access the messages as SYS_RES_IRQ resources
starting at rid 1. Note that the legacy INTx interrupt resource will
not be available when using MSI. Note that this function will allocate
either MSI or MSI-X messages depending on the devices capabilities and
the 'hw.pci.enable_msix' and 'hw.pci.enable_msi' tunables. Also note
that the driver should activate the memory resource that holds the
MSI-X table and pending bit array (PBA) before calling this function
if the device supports MSI-X.
- pci_release_msi(dev) backed by PCI_RELEASE_MSI(). This function
releases the messages allocated for this device. All of the
SYS_RES_IRQ resources need to be released for this function to succeed.
- pci_msi_count(dev) backed by PCI_MSI_COUNT(). This function returns
the maximum number of MSI or MSI-X messages supported by this device.
MSI-X is preferred if present, but this function will honor the
'hw.pci.enable_msix' and 'hw.pci.enable_msi' tunables. This function
should return the largest value that pci_alloc_msi() can return
(assuming the MD code is able to allocate sufficient backing resources
for all of the messages).
- Add default implementations for these 3 methods to the pci_driver generic
PCI bus driver. (The various other PCI bus drivers such as for ACPI and
OFW will inherit these default implementations.) This default
implementation depends on 4 new pcib_if methods that bubble up through
the PCI bridges to the MD code to allocate IRQ values and perform any
needed MD setup code needed:
- PCIB_ALLOC_MSI() attempts to allocate a group of MSI messages.
- PCIB_RELEASE_MSI() releases a group of MSI messages.
- PCIB_ALLOC_MSIX() attempts to allocate a single MSI-X message.
- PCIB_RELEASE_MSIX() releases a single MSI-X message.
- Add default implementations for these 4 methods that just pass the
request up to the parent bus's parent bridge driver and use the
default implementation in the various MI PCI bridge drivers.
- Add MI functions for use by MD code when managing MSI and MSI-X
interrupts:
- pci_enable_msi(dev, address, data) programs the MSI capability address
and data registers for a group of MSI messages
- pci_enable_msix(dev, index, address, data) initializes a single MSI-X
message in the MSI-X table
- pci_mask_msix(dev, index) masks a single MSI-X message
- pci_unmask_msix(dev, index) unmasks a single MSI-X message
- pci_pending_msix(dev, index) returns true if the specified MSI-X
message is currently pending
- Save the MSI capability address and data registers in the pci_cfgreg
block in a PCI devices ivars and restore the values when a device is
resumed. Note that the MSI-X table is not currently restored during
resume.
- Add constants for MSI-X register offsets and fields.
- Record interesting data about any MSI-X capability blocks we come
across in the pci_cfgreg block in the ivars for PCI devices.
Tested on: em (i386, MSI), bce (amd64/i386, MSI), mpt (amd64, MSI-X)
Reviewed by: scottl, grehan, jfv
MFC after: 2 months
93 lines
4.1 KiB
C
93 lines
4.1 KiB
C
/*-
|
|
* Copyright (c) 1997, Stefan Esser <se@freebsd.org>
|
|
* Copyright (c) 2000, Michael Smith <msmith@freebsd.org>
|
|
* Copyright (c) 2000, BSDi
|
|
* 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 unmodified, 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.
|
|
*
|
|
* 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.
|
|
*
|
|
* $FreeBSD$
|
|
*
|
|
*/
|
|
|
|
#ifndef _PCI_PRIVATE_H_
|
|
#define _PCI_PRIVATE_H_
|
|
|
|
/*
|
|
* Export definitions of the pci bus so that we can more easily share
|
|
* it with "subclass" busses.
|
|
*/
|
|
DECLARE_CLASS(pci_driver);
|
|
|
|
void pci_add_children(device_t dev, int busno, size_t dinfo_size);
|
|
void pci_add_child(device_t bus, struct pci_devinfo *dinfo);
|
|
void pci_add_resources(device_t bus, device_t dev, int force,
|
|
uint32_t prefetchmask);
|
|
void pci_driver_added(device_t dev, driver_t *driver);
|
|
int pci_print_child(device_t dev, device_t child);
|
|
void pci_probe_nomatch(device_t dev, device_t child);
|
|
int pci_read_ivar(device_t dev, device_t child, int which,
|
|
uintptr_t *result);
|
|
int pci_write_ivar(device_t dev, device_t child, int which,
|
|
uintptr_t value);
|
|
int pci_get_vpd_ident_method(device_t dev, device_t child,
|
|
const char **identptr);
|
|
int pci_get_vpd_readonly_method(device_t dev, device_t child,
|
|
const char *kw, const char **vptr);
|
|
int pci_set_powerstate_method(device_t dev, device_t child,
|
|
int state);
|
|
int pci_get_powerstate_method(device_t dev, device_t child);
|
|
uint32_t pci_read_config_method(device_t dev, device_t child,
|
|
int reg, int width);
|
|
void pci_write_config_method(device_t dev, device_t child,
|
|
int reg, uint32_t val, int width);
|
|
int pci_enable_busmaster_method(device_t dev, device_t child);
|
|
int pci_disable_busmaster_method(device_t dev, device_t child);
|
|
int pci_enable_io_method(device_t dev, device_t child, int space);
|
|
int pci_disable_io_method(device_t dev, device_t child, int space);
|
|
int pci_find_extcap_method(device_t dev, device_t child,
|
|
int capability, int *capreg);
|
|
int pci_alloc_msi_method(device_t dev, device_t child, int *count);
|
|
int pci_release_msi_method(device_t dev, device_t child);
|
|
int pci_msi_count_method(device_t dev, device_t child);
|
|
struct resource *pci_alloc_resource(device_t dev, device_t child,
|
|
int type, int *rid, u_long start, u_long end, u_long count,
|
|
u_int flags);
|
|
void pci_delete_resource(device_t dev, device_t child,
|
|
int type, int rid);
|
|
struct resource_list *pci_get_resource_list (device_t dev, device_t child);
|
|
struct pci_devinfo *pci_read_device(device_t pcib, int b, int s, int f,
|
|
size_t size);
|
|
void pci_print_verbose(struct pci_devinfo *dinfo);
|
|
int pci_freecfg(struct pci_devinfo *dinfo);
|
|
int pci_child_location_str_method(device_t cbdev, device_t child,
|
|
char *buf, size_t buflen);
|
|
int pci_child_pnpinfo_str_method(device_t cbdev, device_t child,
|
|
char *buf, size_t buflen);
|
|
int pci_assign_interrupt_method(device_t dev, device_t child);
|
|
int pci_resume(device_t dev);
|
|
int pci_suspend(device_t dev);
|
|
void pci_cfg_restore(device_t, struct pci_devinfo *);
|
|
void pci_cfg_save(device_t, struct pci_devinfo *, int);
|
|
|
|
#endif /* _PCI_PRIVATE_H_ */
|