FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/drivers/peripherals/twid_legacy.h

/* ----------------------------------------------------------------------------
 *         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_
#define _TWID_

/*----------------------------------------------------------------------------
 *        Headers
 *----------------------------------------------------------------------------*/

#include "board.h"
#include "peripherals/twi.h"
#include "async.h"

#include <stdint.h>

/*----------------------------------------------------------------------------
 *        Definition
 *----------------------------------------------------------------------------*/

/** TWI driver is currently busy. */
#define TWID_ERROR_BUSY              1

// TWI clock frequency in Hz.
#define TWCK_400K            400000
#define TWCK_200K            200000
#define TWCK_100K            100000

#ifdef __cplusplus
extern "C" {
#endif

/*----------------------------------------------------------------------------
 *        Types
 *----------------------------------------------------------------------------*/

/** \brief TWI driver structure. Holds the internal state of the driver.*/
struct _twid {
	Twi *pTwi;			/** Pointer to the underlying TWI peripheral.*/
	struct _async *pTransfer;	/** Current asynchronous transfer being processed.*/
};

struct _handler_twi
{
	uint8_t	IdTwi;      // ID TWI
	uint8_t	Status;     // status of the TWI
	uint8_t	PeriphAddr; // Address of the component
	uint8_t	LenData;    // Lenfth of the data to be read or write
	uint8_t	AddSize;    // Size of the address
	uint16_t RegMemAddr; // Address of the memory or register
	uint32_t Twck;       // default clock of the bus TWI
	uint8_t* pData;      // pointer to a data buffer
	struct _twid	twid;
};


enum TWI_CMD
{
	TWI_RD   = 0,
	TWI_WR   = 1
};

enum TWI_STATUS
{
	TWI_STATUS_RESET  = 0,
	TWI_STATUS_HANDLE = 1u<<0,
	TWI_STATUS_RFU2   = 1u<<1,
	TWI_STATUS_RFU3   = 1u<<2,
	TWI_STATUS_RFU4   = 1u<<3,
	TWI_STATUS_READY  = 1u<<7,
};

enum TWI_RESULT
{
	TWI_SUCCES   = 0,
	TWI_FAIL	 = 1
};

/*----------------------------------------------------------------------------
 *        Export functions
 *----------------------------------------------------------------------------*/
extern void twid_initialize(struct _twid* pTwid, Twi * pTwi);

extern void twid_handler(struct _twid* pTwid);

extern uint8_t twid_read(struct _twid* pTwid, uint8_t address, uint32_t iaddress,
			 uint8_t isize, uint8_t * pData, uint32_t num, struct _async * pAsync);

extern uint8_t twid_dma_read(struct _twid* pTwid, uint8_t address, uint32_t iaddress,
			    uint8_t isize, uint8_t * pData, uint32_t num,
			    struct _async * pAsync, uint8_t TWI_ID);

extern uint8_t twid_write(struct _twid* pTwid, uint8_t address, uint32_t iaddress,
			  uint8_t isize, uint8_t * pData, uint32_t num, struct _async * pAsync);

extern uint8_t twid_dma_write(struct _twid* pTwid, uint8_t address,
			     uint32_t iaddress, uint8_t isize, uint8_t * pData,
			     uint32_t num, struct _async * pAsync, uint8_t TWI_ID);
#ifdef __cplusplus
}
#endif
#endif				//#ifndef TWID_H