/* ----------------------------------------------------------------------------
 *         SAM Software Package License
 * ----------------------------------------------------------------------------
 * Copyright (c) 2015, Atmel Corporation
 *
 * 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 disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL 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 TWID_HEADER__
#define TWID_HEADER__

/*------------------------------------------------------------------------------
 *        Header
 *----------------------------------------------------------------------------*/

#include "peripherals/twi.h"
#include "mutex.h"
#include "io.h"

/*------------------------------------------------------------------------------
 *        Types
 *----------------------------------------------------------------------------*/

#define TWID_SUCCESS         (0)
#define TWID_INVALID_ID      (1)
#define TWID_INVALID_BITRATE (2)
#define TWID_ERROR_LOCK      (3)
#define TWID_ERROR_DUPLEX    (4)
#define TWID_ERROR_ACK       (5)
#define TWID_ERROR_TIMEOUT   (6)
#define TWID_ERROR_TRANSFER  (7)

enum _twid_trans_mode
{
	TWID_MODE_POLLING,
	TWID_MODE_FIFO,
	TWID_MODE_DMA
};

struct _twi_desc;

typedef void (*twid_callback_t)(struct _twi_desc* spid, void* args);

struct _twi_desc
{
	Twi*  addr;
	uint32_t freq;
	uint32_t slave_addr;
	uint32_t iaddr;
	uint32_t isize;
	uint8_t transfert_mode;
	/* implicit internal padding is mandatory here */
	mutex_t mutex;
	uint32_t region_start;
	uint32_t region_end;
	twid_callback_t callback;
	void*   cb_args;
};

/*------------------------------------------------------------------------------
 *        Functions
 *----------------------------------------------------------------------------*/

extern void twid_configure(struct _twi_desc* desc);
extern uint32_t twid_transfert(struct _twi_desc* desc, struct _buffer* rx,
			  struct _buffer* tx, twid_callback_t cb,
			  void* user_args);
extern void twid_finish_transfert_callback(struct _twi_desc* desc,
				      void* user_args);
extern void twid_finish_transfert(struct _twi_desc* desc);
extern uint32_t twid_is_busy(const struct _twi_desc* desc);
extern void twid_wait_transfert(const struct _twi_desc* desc);

#endif /* TWID_HEADER__ */