/*
 * Copyright (c) 2010 Matus Dekanek
 * 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 drvusbhub
 * @{
 */
/** @file
 * @brief Hub driver private definitions
 */

#ifndef USBHUB_PRIVATE_H
#define	USBHUB_PRIVATE_H

#include "usbhub.h"
#include "usblist.h"

#include <adt/list.h>
#include <bool.h>
#include <ddf/driver.h>
#include <fibril_synch.h>

#include <usb/classes/hub.h>
#include <usb/usb.h>
#include <usb/debug.h>
#include <usb/request.h>

//************
//
// convenience define for malloc
//
//************
#define usb_new(type) (type*)malloc(sizeof(type))


//************
//
// convenience debug printf for usb hub
//
//************
#define dprintf(level, format, ...) \
	usb_log_printf((level), format "\n", ##__VA_ARGS__)


/**
 * Create hub structure instance
 *
 * Set the address and port count information most importantly.
 *
 * @param device
 * @param hc host controller phone
 * @return
 */
usb_hub_info_t * usb_create_hub_info(ddf_dev_t * device);

/** List of hubs maanged by this driver */
extern usb_general_list_t usb_hub_list;

/** Lock for hub list*/
extern fibril_mutex_t usb_hub_list_lock;


/**
 * Perform complete control read transaction
 *
 * Manages all three steps of transaction: setup, read and finalize
 * @param phone
 * @param target
 * @param request Request packet
 * @param rcvd_buffer Received data
 * @param rcvd_size
 * @param actual_size Actual size of received data
 * @return error code
 */
/*
int usb_drv_sync_control_read(
    usb_endpoint_pipe_t *pipe,
    usb_device_request_setup_packet_t * request,
    void * rcvd_buffer, size_t rcvd_size, size_t * actual_size
);*/

/**
 * Perform complete control write transaction
 *
 * Manages all three steps of transaction: setup, write and finalize
 * @param phone
 * @param target
 * @param request Request packet to send data
 * @param sent_buffer
 * @param sent_size
 * @return error code
 */
/*int usb_drv_sync_control_write(
    usb_endpoint_pipe_t *pipe,
    usb_device_request_setup_packet_t * request,
    void * sent_buffer, size_t sent_size
);*/

/**
 * Set the device request to be a get hub descriptor request.
 * @warning the size is allways set to USB_HUB_MAX_DESCRIPTOR_SIZE
 * @param request
 * @param addr
 */
static inline void usb_hub_set_descriptor_request(
usb_device_request_setup_packet_t * request
){
	request->index = 0;
	request->request_type = USB_HUB_REQ_TYPE_GET_DESCRIPTOR;
	request->request = USB_HUB_REQUEST_GET_DESCRIPTOR;
	request->value_high = USB_DESCTYPE_HUB;
	request->value_low = 0;
	request->length = USB_HUB_MAX_DESCRIPTOR_SIZE;
}

/**
 * Clear feature on hub port.
 *
 * @param hc Host controller telephone
 * @param address Hub address
 * @param port_index Port
 * @param feature Feature selector
 * @return Operation result
 */
static inline int usb_hub_clear_port_feature(usb_endpoint_pipe_t *pipe,
    int port_index,
    usb_hub_class_feature_t feature) {
	
	usb_device_request_setup_packet_t clear_request = {
		.request_type = USB_HUB_REQ_TYPE_CLEAR_PORT_FEATURE,
		.request = USB_DEVREQ_CLEAR_FEATURE,
		.length = 0,
		.index = port_index
	};
	clear_request.value = feature;
	return usb_endpoint_pipe_control_write(pipe, &clear_request,
	    sizeof(clear_request), NULL, 0);
}

/**
 * @brief create uint8_t array with serialized descriptor
 *
 * @param descriptor
 * @return newly created serializd descriptor pointer
 */
void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor);

/**
 * @brief create deserialized desriptor structure out of serialized descriptor
 *
 * The serialized descriptor must be proper usb hub descriptor,
 * otherwise an eerror might occur.
 *
 * @param sdescriptor serialized descriptor
 * @return newly created deserialized descriptor pointer
 */
usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * sdescriptor);


#endif	/* USBHUB_PRIVATE_H */

/**
 * @}
 */