1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Functions used by both the SCSI initiator code and the SCSI target code.
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #ifndef _SCSI_COMMON_H_
7*4882a593Smuzhiyun #define _SCSI_COMMON_H_
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <linux/types.h>
10*4882a593Smuzhiyun #include <scsi/scsi_proto.h>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun static inline unsigned
scsi_varlen_cdb_length(const void * hdr)13*4882a593Smuzhiyun scsi_varlen_cdb_length(const void *hdr)
14*4882a593Smuzhiyun {
15*4882a593Smuzhiyun return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
16*4882a593Smuzhiyun }
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun extern const unsigned char scsi_command_size_tbl[8];
19*4882a593Smuzhiyun #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun static inline unsigned
scsi_command_size(const unsigned char * cmnd)22*4882a593Smuzhiyun scsi_command_size(const unsigned char *cmnd)
23*4882a593Smuzhiyun {
24*4882a593Smuzhiyun return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
25*4882a593Smuzhiyun scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
26*4882a593Smuzhiyun }
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun static inline unsigned char
scsi_command_control(const unsigned char * cmnd)29*4882a593Smuzhiyun scsi_command_control(const unsigned char *cmnd)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
32*4882a593Smuzhiyun cmnd[1] : cmnd[COMMAND_SIZE(cmnd[0]) - 1];
33*4882a593Smuzhiyun }
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun /* Returns a human-readable name for the device */
36*4882a593Smuzhiyun extern const char *scsi_device_type(unsigned type);
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun extern void int_to_scsilun(u64, struct scsi_lun *);
39*4882a593Smuzhiyun extern u64 scsilun_to_int(struct scsi_lun *);
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun /*
42*4882a593Smuzhiyun * This is a slightly modified SCSI sense "descriptor" format header.
43*4882a593Smuzhiyun * The addition is to allow the 0x70 and 0x71 response codes. The idea
44*4882a593Smuzhiyun * is to place the salient data from either "fixed" or "descriptor" sense
45*4882a593Smuzhiyun * format into one structure to ease application processing.
46*4882a593Smuzhiyun *
47*4882a593Smuzhiyun * The original sense buffer should be kept around for those cases
48*4882a593Smuzhiyun * in which more information is required (e.g. the LBA of a MEDIUM ERROR).
49*4882a593Smuzhiyun */
50*4882a593Smuzhiyun struct scsi_sense_hdr { /* See SPC-3 section 4.5 */
51*4882a593Smuzhiyun u8 response_code; /* permit: 0x0, 0x70, 0x71, 0x72, 0x73 */
52*4882a593Smuzhiyun u8 sense_key;
53*4882a593Smuzhiyun u8 asc;
54*4882a593Smuzhiyun u8 ascq;
55*4882a593Smuzhiyun u8 byte4;
56*4882a593Smuzhiyun u8 byte5;
57*4882a593Smuzhiyun u8 byte6;
58*4882a593Smuzhiyun u8 additional_length; /* always 0 for fixed sense format */
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun
scsi_sense_valid(const struct scsi_sense_hdr * sshdr)61*4882a593Smuzhiyun static inline bool scsi_sense_valid(const struct scsi_sense_hdr *sshdr)
62*4882a593Smuzhiyun {
63*4882a593Smuzhiyun if (!sshdr)
64*4882a593Smuzhiyun return false;
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun return (sshdr->response_code & 0x70) == 0x70;
67*4882a593Smuzhiyun }
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun extern bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
70*4882a593Smuzhiyun struct scsi_sense_hdr *sshdr);
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun extern void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq);
73*4882a593Smuzhiyun int scsi_set_sense_information(u8 *buf, int buf_len, u64 info);
74*4882a593Smuzhiyun int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd);
75*4882a593Smuzhiyun extern const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
76*4882a593Smuzhiyun int desc_type);
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun #endif /* _SCSI_COMMON_H_ */
79