/*
 * Copyright (c) 2011 Jan Vesely
 * Copyright (c) 2011 Vojtech Horky
 * 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 drvusbohci
 * @{
 */
/** @file
 * Main routines of OHCI driver.
 */

#include <assert.h>
#include <ddf/driver.h>
#include <errno.h>
#include <io/log.h>
#include <str_error.h>

#include <usb/debug.h>
#include <usb/host/ddf_helpers.h>

#include "hc.h"
#include "ohci_bus.h"

#define NAME "ohci"
static int ohci_driver_init(hcd_t *, const hw_res_list_parsed_t *, ddf_dev_t *);
static int ohci_driver_start(hcd_t *, bool);
static int ohci_driver_claim(hcd_t *, ddf_dev_t *);
static void ohci_driver_fini(hcd_t *);

static const ddf_hc_driver_t ohci_hc_driver = {
        .irq_code_gen = ohci_hc_gen_irq_code,
        .init = ohci_driver_init,
        .claim = ohci_driver_claim,
        .start = ohci_driver_start,
	.setup_root_hub = hcd_setup_virtual_root_hub,
        .fini = ohci_driver_fini,
        .name = "OHCI",
	.ops = {
                .schedule       = ohci_hc_schedule,
                .irq_hook       = ohci_hc_interrupt,
                .status_hook    = ohci_hc_status,
	},
};


static int ohci_driver_init(hcd_t *hcd, const hw_res_list_parsed_t *res, ddf_dev_t *device)
{
	int err;

	assert(hcd);
	assert(hcd_get_driver_data(hcd) == NULL);

	hc_t *instance = malloc(sizeof(hc_t));
	if (!instance)
		return ENOMEM;

	if ((err = hc_init(instance, res)) != EOK)
		goto err;

	if ((err = ohci_bus_init(&instance->bus, instance)))
		goto err;

	hcd_set_implementation(hcd, instance, &ohci_hc_driver.ops, &instance->bus.base.base);

	return EOK;

err:
	free(instance);
	return err;
}

static int ohci_driver_claim(hcd_t *hcd, ddf_dev_t *dev)
{
	hc_t *hc = hcd_get_driver_data(hcd);
	assert(hc);

	hc_gain_control(hc);

	return EOK;
}

static int ohci_driver_start(hcd_t *hcd, bool interrupts)
{
	hc_t *hc = hcd_get_driver_data(hcd);
	assert(hc);

	hc->hw_interrupts = interrupts;
	hc_start(hc);
	return EOK;
}

static void ohci_driver_fini(hcd_t *hcd)
{
	assert(hcd);
	hc_t *hc = hcd_get_driver_data(hcd);
	if (hc)
		hc_fini(hc);

	hcd_set_implementation(hcd, NULL, NULL, NULL);
	free(hc);
}

/** Initializes a new ddf driver instance of OHCI hcd.
 *
 * @param[in] device DDF instance of the device to initialize.
 * @return Error code.
 */
static int ohci_dev_add(ddf_dev_t *device)
{
	usb_log_debug("ohci_dev_add() called\n");
	assert(device);
	return hcd_ddf_add_hc(device, &ohci_hc_driver);
}

static int ohci_fun_online(ddf_fun_t *fun)
{
	return hcd_ddf_device_online(fun);
}

static int ohci_fun_offline(ddf_fun_t *fun)
{
	return hcd_ddf_device_offline(fun);
}


static const driver_ops_t ohci_driver_ops = {
	.dev_add = ohci_dev_add,
	.fun_online = ohci_fun_online,
	.fun_offline = ohci_fun_offline
};

static const driver_t ohci_driver = {
	.name = NAME,
	.driver_ops = &ohci_driver_ops
};

/** Initializes global driver structures (NONE).
 *
 * @param[in] argc Nmber of arguments in argv vector (ignored).
 * @param[in] argv Cmdline argument vector (ignored).
 * @return Error code.
 *
 * Driver debug level is set here.
 */
int main(int argc, char *argv[])
{
	log_init(NAME);
	return ddf_driver_main(&ohci_driver);
}

/**
 * @}
 */