/*
 * Copyright (c) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - 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.
 */

/** @addtogroup ofw
 * @{
 */
/**
 * @file
 * @brief	PCI 'reg' and 'ranges' properties handling.
 *
 */

#include <genarch/ofw/ofw_tree.h>
#include <arch/drivers/pci.h>
#include <arch/trap/interrupt.h>
#include <arch/memstr.h>
#include <string.h>
#include <panic.h>
#include <macros.h>

#define PCI_SPACE_MASK		0x03000000
#define PCI_ABS_MASK		0x80000000	
#define PCI_REG_MASK		0x000000ff

#define PCI_IGN			0x1f

bool
ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa)
{
	ofw_tree_property_t *prop;
	ofw_pci_range_t *range;
	size_t ranges;

	prop = ofw_tree_getprop(node, "ranges");
	if (!prop) {
		if (str_cmp(ofw_tree_node_name(node->parent), "pci") == 0)
			return ofw_pci_apply_ranges(node->parent, reg, pa);
		return false;
	}
		
	ranges = prop->size / sizeof(ofw_pci_range_t);
	range = prop->value;
	
	unsigned int i;
	
	for (i = 0; i < ranges; i++) {
		if ((reg->space & PCI_SPACE_MASK) !=
		    (range[i].space & PCI_SPACE_MASK))
			continue;
		if (overlaps(reg->addr, reg->size, range[i].child_base,
		    range[i].size)) {
			*pa = range[i].parent_base +
			    (reg->addr - range[i].child_base);
			return true;
		}
	}

	return false;
}

bool
ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg,
    ofw_pci_reg_t *out)
{
	if (reg->space & PCI_ABS_MASK) {
		/* already absolute */
		out->space = reg->space;
		out->addr = reg->addr;
		out->size = reg->size;
		return true;
	}
	
	ofw_tree_property_t *prop;
	ofw_pci_reg_t *assigned_address;
	size_t assigned_addresses;
	
	prop = ofw_tree_getprop(node, "assigned-addresses");
	if (!prop)
		panic("Cannot find 'assigned-addresses' property.");
	
	assigned_addresses = prop->size / sizeof(ofw_pci_reg_t);
	assigned_address = prop->value;
	
	unsigned int i;
	
	for (i = 0; i < assigned_addresses; i++) {
		if ((assigned_address[i].space & PCI_REG_MASK) ==
		    (reg->space & PCI_REG_MASK)) {
			out->space = assigned_address[i].space;
			out->addr = reg->addr + assigned_address[i].addr;
			out->size = reg->size;
			return true;
		}
	}
	
	return false;
}

/** Map PCI interrupt.
 *
 * So far, we only know how to map interrupts of non-PCI devices connected
 * to a PCI bridge.
 */
bool
ofw_pci_map_interrupt(ofw_tree_node_t *node, ofw_pci_reg_t *reg, int ino,
    int *inr, cir_t *cir, void **cir_arg)
{
	pci_t *pci = node->device;
	if (!pci) {
		pci = pci_init(node);
		if (!pci)
			return false;
		node->device = pci;
	}

	pci_enable_interrupt(pci, ino);

	*inr = (PCI_IGN << IGN_SHIFT) | ino;
	*cir = pci_clear_interrupt;
	*cir_arg = pci;

	return true;
}

/** @}
 */