/*---------------------------------------------------------------------------*
  Project:  TwlSDK - camera - include
  File:     fifo.h

  Copyright 2007 Nintendo.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Log: $
  $NoKeywords: $
 *---------------------------------------------------------------------------*/
#ifndef TWL_CAMERA_FIFO_H_
#define TWL_CAMERA_FIFO_H_

/*---------------------------------------------------------------------------*
    定数定義
 *---------------------------------------------------------------------------*/
// プロトコル関連定義
#define CAMERA_PXI_CONTINUOUS_PACKET_MAX       4           // 連続パケットの最大連続回数
#define CAMERA_PXI_DATA_SIZE_MAX               ((CAMERA_PXI_CONTINUOUS_PACKET_MAX-1)*3+1) // 最大データ数

#define CAMERA_PXI_START_BIT                   0x02000000  // 先頭パケットを意味する
#define CAMERA_PXI_RESULT_BIT                  0x00008000  // PXIの応答を示す

/* 先頭パケットのみの規則 */
#define CAMERA_PXI_DATA_NUMS_MASK              0x00ff0000  // データ数領域
#define CAMERA_PXI_DATA_NUMS_SHIFT             16          // データ数位置
#define CAMERA_PXI_COMMAND_MASK                0x00007f00  // コマンド格納部分のマスク
#define CAMERA_PXI_COMMAND_SHIFT               8           // コマンド格納部分の位置
#define CAMERA_PXI_1ST_DATA_MASK               0x000000ff  // 先頭パケットのデータ領域
#define CAMERA_PXI_1ST_DATA_SHIFT              0           // 先頭パケットのデータ位置

/* 後続パケットのみの規則 */
#define CAMERA_PXI_DATA_MASK                   0x00ffffff  // データ領域
#define CAMERA_PXI_DATA_SHIFT                  0           // データ位置

#ifdef  __cplusplus
extern "C" {
#endif

/*===========================================================================*/

// PXIコマンド定義
typedef enum CAMERAPxiCommand
{
    CAMERA_PXI_COMMAND_SET_STBYN                    = 0x00, // STBYN操作
    // I2C基本操作
    CAMERA_PXI_COMMAND_WRITE_REGISTERS              = 0x10,
    CAMERA_PXI_COMMAND_READ_REGISTERS               = 0x11,
    CAMERA_PXI_COMMAND_SET_PARAMS                   = 0x12,
    CAMERA_PXI_COMMAND_SET_FLAGS                    = 0x13,
    CAMERA_PXI_COMMAND_CLEAR_FLAGS                  = 0x14,
    // I2C応用操作
    CAMERA_PXI_COMMAND_I2C_INIT                     = 0x20, // 汎用初期化
    CAMERA_PXI_COMMAND_I2C_PRESET                   = 0x21, // 各種プリセット

    CAMERA_PXI_COMMAND_I2C_PRE_SLEEP                = 0x28, // スリープ前処理
    CAMERA_PXI_COMMAND_I2C_POST_SLEEP               = 0x29, // スリープ後処理

    CAMERA_PXI_COMMAND_I2C_SET_CROPPING             = 0x30, // 位置とサイズ設定

    CAMERA_PXI_COMMAND_I2C_PAUSE                    = 0x38, // 一時停止
    CAMERA_PXI_COMMAND_I2C_RESUME                   = 0x39  // 復帰
}
CAMERAPxiCommand;

// PXIコマンドサイズ定義
typedef enum CAMERAPxiSize
{
    CAMERA_PXI_SIZE_SET_STBYN                       = 1, // BOOL
    // I2C基本操作
    CAMERA_PXI_SIZE_WRITE_REGISTERS                 = 3,    // addr, size, data...
    CAMERA_PXI_SIZE_READ_REGISTERS                  = 2,    // addr, size
    CAMERA_PXI_SIZE_SET_PARAMS                      = 3,    // addr, bits, mask
    CAMERA_PXI_SIZE_SET_FLAGS                       = 2,    // addr, bits
    CAMERA_PXI_SIZE_CLEAR_FLAGS                     = 2,    // addr, bits
    // I2C応用操作
    CAMERA_PXI_SIZE_I2C_INIT                        = 0,
    CAMERA_PXI_SIZE_I2C_PRESET                      = 1,    // preset

    CAMERA_PXI_SIZE_I2C_PRE_SLEEP                   = 0,
    CAMERA_PXI_SIZE_I2C_POST_SLEEP                  = 0,

    CAMERA_PXI_SIZE_I2C_SET_CROPPING                = 8,    // (u16)x_offset, (u16)y_offset, (u16)width, (u16)height

    CAMERA_PXI_SIZE_I2C_PAUSE                       = 0,
    CAMERA_PXI_SIZE_I2C_RESUME                      = 0
}
CAMERAPxiSize;

// 応答定義
typedef enum CAMERAPxiResult
{
    CAMERA_PXI_RESULT_SUCCESS = 0,        // 処理成功 (void/void*型) // 場合により後続パケットあり
    CAMERA_PXI_RESULT_SUCCESS_TRUE,       // 処理成功 (BOOL型)
    CAMERA_PXI_RESULT_SUCCESS_FALSE,      // 処理成功 (BOOL型)
    CAMERA_PXI_RESULT_INVALID_COMMAND,    // 不正なPXIコマンド
    CAMERA_PXI_RESULT_INVALID_PARAMETER,  // 不正なパラメータ
    CAMERA_PXI_RESULT_ILLEGAL_STATUS,     // RTCの状態により処理を実行不能
    CAMERA_PXI_RESULT_BUSY,               // 他のリクエストを実行中
    CAMERA_PXI_RESULT_FATAL_ERROR,        // その他何らかの原因で処理に失敗
    CAMERA_PXI_RESULT_MAX
}
CAMERAPxiResult;


/*===========================================================================*/

#ifdef  __cplusplus
}          /* extern "C" */
#endif

#endif /* TWL_CAMERA_FIFO_H_ */

/*---------------------------------------------------------------------------*
  End of file
 *---------------------------------------------------------------------------*/