/*-
 * 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: src/sys/dev/pci/pci_private.h,v 1.25.8.1 2009/04/15 03:14:26 kensmith Exp $
 *
 */

#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 domain, int busno,
                    size_t dinfo_size);
void            pci_add_child(device_t bus, struct pci_devinfo *dinfo);
void            pci_add_resources(device_t pcib, 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_setup_intr(device_t dev, device_t child,
                    struct resource *irq, int flags,
                    driver_intr_t *intr, void *arg, void **cookiep,
                    lwkt_serialize_t serializer, const char *desc);
int             pci_teardown_intr(device_t dev, device_t child,
                    struct resource *irq, void *cookie);
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 *rid, int count, int cpuid);
int             pci_alloc_msix_vector_method(device_t dev, device_t child, u_int vector, int *rid, int cpuid);
int             pci_release_msi_method(device_t dev, device_t child);
int             pci_release_msix_vector_method(device_t dev, device_t child, int rid);
int             pci_msi_count_method(device_t dev, device_t child);
int             pci_msix_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, int cpuid);
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 d, 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);

/** Restore the config register state.  The state must be previously
 * saved with pci_cfg_save.  However, the pci bus driver takes care of
 * that.  This function will also return the device to PCI_POWERSTATE_D0
 * if it is currently in a lower power mode.
 */
void            pci_cfg_restore(device_t, struct pci_devinfo *);

/** Save the config register state.  Optionally set the power state to D3
 * if the third argument is non-zero.
 */
void            pci_cfg_save(device_t, struct pci_devinfo *, int);

#endif /* _PCI_PRIVATE_H_ */