/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * 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. Neither the name of the project nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */

#ifndef _PCI_CAM_H_
#define _PCI_CAM_H_ 1

#include <sys/types.h>
#include <io/pci/pci.h>

/*
 * Configuration Access Mechanism hooks for the
 * L5 PCI driver.
 *
 * Contains read/write hooks:
 * [
 *      @dp: Device pointer
 *      @off: Register offset
 *      @v[writel]: Value to write
 * ]
 */
struct cam_hook {
    void(*cam_writel)(struct pci_device *dp, uint32_t off, pcireg_t v);
    pcireg_t(*cam_readl)(struct pci_device *dp, uint32_t off);
};

/*
 * Initialize configuration access mechanism hooks
 * to be used for PCI device access.
 *
 * @chp: (E)CAM hooks
 *
 * Returns zero on success, otherwise a less than zero
 * value to indicate failure.
 */
int pci_cam_init(struct cam_hook *chp);

#endif  /* !_PCI_CAM_H_ */