/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for PDITarget.c.
 */

#ifndef _PDI_TARGET_
#define _PDI_TARGET_

	/* Includes: */
		#include <avr/io.h>
		#include <avr/interrupt.h>
		#include <stdbool.h>
		
		#include <LUFA/Common/Common.h>
	
	/* Preprocessor Checks: */
		#if (BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1)
			#undef  ENABLE_ISP_PROTOCOL
			
			#if !defined(ENABLE_PDI_PROTOCOL)
				#define ENABLE_PDI_PROTOCOL
			#endif
		#endif

	/* Defines: */
		#if BOARD == BOARD_XPLAIN
			#define PDI_VIA_HARDWARE_USART
		#else
			#define BITBANG_PDIDATA_PORT     PORTB
			#define BITBANG_PDIDATA_DDR      DDRB
			#define BITBANG_PDIDATA_PIN      PINB
			#define BITBANG_PDIDATA_MASK     (1 << 3)
			
			#define BITBANG_PDICLOCK_PORT    RESET_LINE_PORT
			#define BITBANG_PDICLOCK_DDR     RESET_LINE_DDR
			#define BITBANG_PDICLOCK_PIN     RESET_LINE_PIN
			#define BITBANG_PDICLOCK_MASK    RESET_LINE_MASK
		#endif
		
		#define BITS_IN_FRAME            12
		
		#define PDI_CMD_LDS              0x00
		#define PDI_CMD_LD               0x20
		#define PDI_CMD_STS              0x40
		#define PDI_CMD_ST               0x60
		#define PDI_CMD_LDCS             0x80
		#define PDI_CMD_REPEAT           0xA0
		#define PDI_CMD_STCS             0xC0
		#define PDI_CMD_KEY              0xE0
		
		#define PDI_STATUS_REG           0
		#define PDI_RESET_REG            1
		#define PDI_CTRL_REG             2
		
		#define PDI_STATUS_NVM           (1 << 1)
		#define PDI_RESET_KEY            0x59

		#define PDI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}

		#define PDI_DATSIZE_1BYTE        0
		#define PDI_DATSIZE_2BYTES       1
		#define PDI_DATSIZE_3BYTES       2
		#define PDI_DATSIZE_4BYTES       3
		
		#define PDI_POINTER_INDIRECT     0
		#define PDI_POINTER_INDIRECT_PI  1
		#define PDI_POINTER_DIRECT       2

		#define FLASH_BASE               0x00800000
		#define EPPROM_BASE              0x008C0000
		#define FUSE_BASE                0x008F0020
		#define DATAMEM_BASE             0x01000000
		#define PROD_SIGNATURE_BASE      0x008E0200
		#define USER_SIGNATURE_BASE      0x008E0400
		
		#define DATAMEM_NVM_BASE         0x01C0
		#define DATAMEM_NVM_ADDR0        (DATAMEM_NVM_BASE | 0x00)
		#define DATAMEM_NVM_ADDR1        (DATAMEM_NVM_BASE | 0x01)
		#define DATAMEM_NVM_ADDR2        (DATAMEM_NVM_BASE | 0x02)
		#define DATAMEM_NVM_DAT0         (DATAMEM_NVM_BASE | 0x04)
		#define DATAMEM_NVM_DAT1         (DATAMEM_NVM_BASE | 0x05)
		#define DATAMEM_NVM_DAT2         (DATAMEM_NVM_BASE | 0x06)
		#define DATAMEM_NVM_CMD          (DATAMEM_NVM_BASE | 0x0A)
		#define DATAMEM_NVM_CTRLA        (DATAMEM_NVM_BASE | 0x0B)
		#define DATAMEM_NVM_CTRLB        (DATAMEM_NVM_BASE | 0x0C)
		#define DATAMEM_NVM_INTCTRL      (DATAMEM_NVM_BASE | 0x0D)
		#define DATAMEM_NVM_STATUS       (DATAMEM_NVM_BASE | 0x0F)
		#define DATAMEM_NVM_LOCKBITS     (DATAMEM_NVM_BASE | 0x10)
		
		#define NVM_CMD_APPCRC           0x38
		#define NVM_CMD_BOOTCRC          0x39
		#define NVM_CMD_FLASHCRC         0x78
		#define NVM_CMD_READUSERSIG      0x03
				
	/* Function Prototypes: */
		void    PDITarget_EnableTargetPDI(void);
		void    PDITarget_DisableTargetPDI(void);
		void    PDITarget_SendByte(uint8_t Byte);
		uint8_t PDITarget_ReceiveByte(void);
		void    PDITarget_SendBreak(void);
		
		void    PDITarget_SendAddress(uint32_t Address);
		bool    PDITarget_WaitWhileNVMBusBusy(void);
		void    PDITarget_WaitWhileNVMControllerBusy(void);

#endif