staging/rts5208/rtsx_scsi.h

0001 /* SPDX-License-Identifier: GPL-2.0+ */
0002 /*
0003  * Driver for Realtek PCI-Express card reader
0004  *
0005  * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved.
0006  *
0007  * Author:
0008  *   Wei WANG (wei_wang@realsil.com.cn)
0009  *   Micky Ching (micky_ching@realsil.com.cn)
0010  */
0011
0012 #ifndef __REALTEK_RTSX_SCSI_H
0013 #define __REALTEK_RTSX_SCSI_H
0014
0015 #include "rtsx.h"
0016 #include "rtsx_chip.h"
0017
0018 #define MS_SP_CMND      0xFA
0019 #define MS_FORMAT       0xA0
0020 #define GET_MS_INFORMATION  0xB0
0021
0022 #define VENDOR_CMND     0xF0
0023
0024 #define READ_STATUS     0x09
0025
0026 #define READ_EEPROM     0x04
0027 #define WRITE_EEPROM        0x05
0028 #define READ_MEM        0x0D
0029 #define WRITE_MEM       0x0E
0030 #define GET_BUS_WIDTH       0x13
0031 #define GET_SD_CSD      0x14
0032 #define TOGGLE_GPIO     0x15
0033 #define TRACE_MSG       0x18
0034
0035 #define SCSI_APP_CMD        0x10
0036
0037 #define PP_READ10       0x1A
0038 #define PP_WRITE10      0x0A
0039 #define READ_HOST_REG       0x1D
0040 #define WRITE_HOST_REG      0x0D
0041 #define SET_VAR         0x05
0042 #define GET_VAR         0x15
0043 #define DMA_READ        0x16
0044 #define DMA_WRITE       0x06
0045 #define GET_DEV_STATUS      0x10
0046 #define SET_CHIP_MODE       0x27
0047 #define SUIT_CMD        0xE0
0048 #define WRITE_PHY       0x07
0049 #define READ_PHY        0x17
0050 #define WRITE_EEPROM2       0x03
0051 #define READ_EEPROM2        0x13
0052 #define ERASE_EEPROM2       0x23
0053 #define WRITE_EFUSE     0x04
0054 #define READ_EFUSE      0x14
0055 #define WRITE_CFG       0x0E
0056 #define READ_CFG        0x1E
0057
0058 #define SPI_VENDOR_COMMAND      0x1C
0059
0060 #define SCSI_SPI_GETSTATUS      0x00
0061 #define SCSI_SPI_SETPARAMETER       0x01
0062 #define SCSI_SPI_READFALSHID        0x02
0063 #define SCSI_SPI_READFLASH      0x03
0064 #define SCSI_SPI_WRITEFLASH     0x04
0065 #define SCSI_SPI_WRITEFLASHSTATUS   0x05
0066 #define SCSI_SPI_ERASEFLASH     0x06
0067
0068 #define INIT_BATCHCMD       0x41
0069 #define ADD_BATCHCMD        0x42
0070 #define SEND_BATCHCMD       0x43
0071 #define GET_BATCHRSP        0x44
0072
0073 #define CHIP_NORMALMODE     0x00
0074 #define CHIP_DEBUGMODE      0x01
0075
0076 /* SD Pass Through Command Extension */
0077 #define SD_PASS_THRU_MODE   0xD0
0078 #define SD_EXECUTE_NO_DATA  0xD1
0079 #define SD_EXECUTE_READ     0xD2
0080 #define SD_EXECUTE_WRITE    0xD3
0081 #define SD_GET_RSP      0xD4
0082 #define SD_HW_RST       0xD6
0083
0084 #ifdef SUPPORT_MAGIC_GATE
0085 #define CMD_MSPRO_MG_RKEY   0xA4   /* Report Key Command */
0086 #define CMD_MSPRO_MG_SKEY   0xA3   /* Send Key Command */
0087
0088 /* CBWCB field: key class */
0089 #define KC_MG_R_PRO     0xBE   /* MG-R PRO*/
0090
0091 /* CBWCB field: key format */
0092 #define KF_SET_LEAF_ID      0x31   /* Set Leaf ID */
0093 #define KF_GET_LOC_EKB      0x32   /* Get Local EKB */
0094 #define KF_CHG_HOST     0x33   /* Challenge (host) */
0095 #define KF_RSP_CHG      0x34   /* Response and Challenge (device)  */
0096 #define KF_RSP_HOST     0x35   /* Response (host) */
0097 #define KF_GET_ICV      0x36   /* Get ICV */
0098 #define KF_SET_ICV      0x37   /* SSet ICV */
0099 #endif
0100
0101 /* Sense type */
0102 #define SENSE_TYPE_NO_SENSE             0
0103 #define SENSE_TYPE_MEDIA_CHANGE             1
0104 #define SENSE_TYPE_MEDIA_NOT_PRESENT            2
0105 #define SENSE_TYPE_MEDIA_LBA_OVER_RANGE         3
0106 #define SENSE_TYPE_MEDIA_LUN_NOT_SUPPORT        4
0107 #define SENSE_TYPE_MEDIA_WRITE_PROTECT          5
0108 #define SENSE_TYPE_MEDIA_INVALID_CMD_FIELD      6
0109 #define SENSE_TYPE_MEDIA_UNRECOVER_READ_ERR     7
0110 #define SENSE_TYPE_MEDIA_WRITE_ERR          8
0111 #define SENSE_TYPE_FORMAT_IN_PROGRESS           9
0112 #define SENSE_TYPE_FORMAT_CMD_FAILED            10
0113 #ifdef SUPPORT_MAGIC_GATE
0114 #define SENSE_TYPE_MG_KEY_FAIL_NOT_ESTAB        0x0b
0115 #define SENSE_TYPE_MG_KEY_FAIL_NOT_AUTHEN       0x0c
0116 #define SENSE_TYPE_MG_INCOMPATIBLE_MEDIUM       0x0d
0117 #define SENSE_TYPE_MG_WRITE_ERR             0x0e
0118 #endif
0119 #ifdef SUPPORT_SD_LOCK
0120 /* FOR Locked SD card*/
0121 #define SENSE_TYPE_MEDIA_READ_FORBIDDEN         0x10
0122 #endif
0123
0124 void scsi_show_command(struct rtsx_chip *chip);
0125 void set_sense_type(struct rtsx_chip *chip, unsigned int lun, int sense_type);
0126 void set_sense_data(struct rtsx_chip *chip, unsigned int lun, u8 err_code,
0127             u8 sense_key, u32 info, u8 asc, u8 ascq,
0128             u8 sns_key_info0, u16 sns_key_info1);
0129 int rtsx_scsi_handler(struct scsi_cmnd *srb, struct rtsx_chip *chip);
0130
0131 #endif   /* __REALTEK_RTSX_SCSI_H */