123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677 |
- #ifndef __OSD_PROTOCOL_H__
- #define __OSD_PROTOCOL_H__
- #include <linux/types.h>
- #include <linux/kernel.h>
- #include <asm/unaligned.h>
- #include <scsi/scsi.h>
- enum {
- OSDv1_ADDITIONAL_CDB_LENGTH = 192,
- OSDv1_TOTAL_CDB_LEN = OSDv1_ADDITIONAL_CDB_LENGTH + 8,
- OSDv1_CAP_LEN = 80,
-
- OSDv2_ADDITIONAL_CDB_LENGTH = 228,
- OSD_ADDITIONAL_CDB_LENGTH =
- OSDv2_ADDITIONAL_CDB_LENGTH,
- OSD_TOTAL_CDB_LEN = OSD_ADDITIONAL_CDB_LENGTH + 8,
- OSD_CAP_LEN = 104,
- OSD_SYSTEMID_LEN = 20,
- OSDv1_CRYPTO_KEYID_SIZE = 20,
- OSDv2_CRYPTO_KEYID_SIZE = 32,
- OSD_CRYPTO_KEYID_SIZE = OSDv2_CRYPTO_KEYID_SIZE,
- OSD_CRYPTO_SEED_SIZE = 4,
- OSD_CRYPTO_NONCE_SIZE = 12,
- OSD_MAX_SENSE_LEN = 252,
- OSD_PARTITION_FIRST_ID = 0x10000,
- OSD_OBJECT_FIRST_ID = 0x10000,
- };
- enum osd_options_byte {
- OSD_CDB_FUA = 0x08,
- OSD_CDB_DPO = 0x10,
- };
- enum osd_options_byte_isolation {
- OSD_ISOLATION_DEFAULT = 0,
- OSD_ISOLATION_NONE = 1,
- OSD_ISOLATION_STRICT = 2,
- OSD_ISOLATION_RANGE = 4,
- OSD_ISOLATION_FUNCTIONAL = 5,
- OSD_ISOLATION_VENDOR = 7,
- };
- enum osd_options_flush_scope_values {
- OSD_CDB_FLUSH_ALL = 0,
- OSD_CDB_FLUSH_ATTR_ONLY = 1,
- OSD_CDB_FLUSH_ALL_RECURSIVE = 2,
-
- OSD_CDB_FLUSH_ALL_RANGE = 2,
- };
- enum {
- OSD_CDB_NORMAL_TIMESTAMPS = 0,
- OSD_CDB_BYPASS_TIMESTAMPS = 0x7f,
- };
- enum osd_attributes_mode {
-
- OSD_CDB_SET_ONE_ATTR = 0x10,
- OSD_CDB_GET_ATTR_PAGE_SET_ONE = 0x20,
- OSD_CDB_GET_SET_ATTR_LISTS = 0x30,
- OSD_CDB_GET_SET_ATTR_MASK = 0x30,
- };
- typedef __be32 osd_cdb_offset;
- enum {
- OSD_OFFSET_UNUSED = 0xFFFFFFFF,
- OSD_OFFSET_MAX_BITS = 28,
- OSDv1_OFFSET_MIN_SHIFT = 8,
- OSD_OFFSET_MIN_SHIFT = 3,
- OSD_OFFSET_MAX_SHIFT = 16,
- };
- osd_cdb_offset __osd_encode_offset(u64 offset, unsigned *padding,
- int min_shift, int max_shift);
- static inline osd_cdb_offset osd_encode_offset_v1(u64 offset, unsigned *padding)
- {
- return __osd_encode_offset(offset, padding,
- OSDv1_OFFSET_MIN_SHIFT, OSD_OFFSET_MAX_SHIFT);
- }
- static inline osd_cdb_offset osd_encode_offset_v2(u64 offset, unsigned *padding)
- {
- return __osd_encode_offset(offset, padding,
- OSD_OFFSET_MIN_SHIFT, OSD_OFFSET_MAX_SHIFT);
- }
- struct osd_cdb_head {
- struct scsi_varlen_cdb_hdr varlen_cdb;
- u8 options;
- u8 command_specific_options;
- u8 timestamp_control;
- u8 reserved1[3];
- __be64 partition;
- __be64 object;
- union {
- struct __osdv1_cdb_addr_len {
- __be32 list_identifier;
- __be64 length;
- __be64 start_address;
- } __packed v1;
- struct __osdv2_cdb_addr_len {
-
- __be64 length;
- __be64 start_address;
- union {
- __be32 list_identifier;
-
- __be32 cdb_continuation_length;
- };
- } __packed v2;
- };
- union {
- struct osd_attributes_page_mode {
- __be32 get_attr_page;
- __be32 get_attr_alloc_length;
- osd_cdb_offset get_attr_offset;
- __be32 set_attr_page;
- __be32 set_attr_id;
- __be32 set_attr_length;
- osd_cdb_offset set_attr_offset;
- } __packed attrs_page;
- struct osd_attributes_list_mode {
- __be32 get_attr_desc_bytes;
- osd_cdb_offset get_attr_desc_offset;
- __be32 get_attr_alloc_length;
- osd_cdb_offset get_attr_offset;
- __be32 set_attr_bytes;
- osd_cdb_offset set_attr_offset;
- __be32 not_used;
- } __packed attrs_list;
-
- struct osd_attributes_cdb_mode {
- __be32 set_attr_page;
- __be32 set_attr_id;
- __be16 set_attr_len;
- u8 set_attr_val[18];
- } __packed attrs_cdb;
- u8 get_set_attributes_parameters[28];
- };
- } __packed;
- struct osdv1_security_parameters {
- u8 integrity_check_value[OSDv1_CRYPTO_KEYID_SIZE];
- u8 request_nonce[OSD_CRYPTO_NONCE_SIZE];
- osd_cdb_offset data_in_integrity_check_offset;
- osd_cdb_offset data_out_integrity_check_offset;
- } __packed;
- struct osdv2_security_parameters {
- u8 integrity_check_value[OSDv2_CRYPTO_KEYID_SIZE];
- u8 request_nonce[OSD_CRYPTO_NONCE_SIZE];
- osd_cdb_offset data_in_integrity_check_offset;
- osd_cdb_offset data_out_integrity_check_offset;
- } __packed;
- struct osd_security_parameters {
- union {
- struct osdv1_security_parameters v1;
- struct osdv2_security_parameters v2;
- };
- };
- struct osdv1_cdb {
- struct osd_cdb_head h;
- u8 caps[OSDv1_CAP_LEN];
- struct osdv1_security_parameters sec_params;
- } __packed;
- struct osdv2_cdb {
- struct osd_cdb_head h;
- u8 caps[OSD_CAP_LEN];
- struct osdv2_security_parameters sec_params;
- } __packed;
- struct osd_cdb {
- union {
- struct osdv1_cdb v1;
- struct osdv2_cdb v2;
- u8 buff[OSD_TOTAL_CDB_LEN];
- };
- } __packed;
- static inline struct osd_cdb_head *osd_cdb_head(struct osd_cdb *ocdb)
- {
- return (struct osd_cdb_head *)ocdb->buff;
- }
- #define OSD_ACT___(Name, Num) \
- OSD_ACT_##Name = cpu_to_be16(0x8880 + Num), \
- OSDv1_ACT_##Name = cpu_to_be16(0x8800 + Num),
- #define OSD_ACT_V2(Name, Num) \
- OSD_ACT_##Name = cpu_to_be16(0x8880 + Num),
- #define OSD_ACT_V1_V2(Name, Num1, Num2) \
- OSD_ACT_##Name = cpu_to_be16(Num2), \
- OSDv1_ACT_##Name = cpu_to_be16(Num1),
- enum osd_service_actions {
- OSD_ACT_V2(OBJECT_STRUCTURE_CHECK, 0x00)
- OSD_ACT___(FORMAT_OSD, 0x01)
- OSD_ACT___(CREATE, 0x02)
- OSD_ACT___(LIST, 0x03)
- OSD_ACT_V2(PUNCH, 0x04)
- OSD_ACT___(READ, 0x05)
- OSD_ACT___(WRITE, 0x06)
- OSD_ACT___(APPEND, 0x07)
- OSD_ACT___(FLUSH, 0x08)
- OSD_ACT_V2(CLEAR, 0x09)
- OSD_ACT___(REMOVE, 0x0A)
- OSD_ACT___(CREATE_PARTITION, 0x0B)
- OSD_ACT___(REMOVE_PARTITION, 0x0C)
- OSD_ACT___(GET_ATTRIBUTES, 0x0E)
- OSD_ACT___(SET_ATTRIBUTES, 0x0F)
- OSD_ACT___(CREATE_AND_WRITE, 0x12)
- OSD_ACT___(CREATE_COLLECTION, 0x15)
- OSD_ACT___(REMOVE_COLLECTION, 0x16)
- OSD_ACT___(LIST_COLLECTION, 0x17)
- OSD_ACT___(SET_KEY, 0x18)
- OSD_ACT___(SET_MASTER_KEY, 0x19)
- OSD_ACT___(FLUSH_COLLECTION, 0x1A)
- OSD_ACT___(FLUSH_PARTITION, 0x1B)
- OSD_ACT___(FLUSH_OSD, 0x1C)
- OSD_ACT_V2(QUERY, 0x20)
- OSD_ACT_V2(REMOVE_MEMBER_OBJECTS, 0x21)
- OSD_ACT_V2(GET_MEMBER_ATTRIBUTES, 0x22)
- OSD_ACT_V2(SET_MEMBER_ATTRIBUTES, 0x23)
- OSD_ACT_V2(CREATE_CLONE, 0x28)
- OSD_ACT_V2(CREATE_SNAPSHOT, 0x29)
- OSD_ACT_V2(DETACH_CLONE, 0x2A)
- OSD_ACT_V2(REFRESH_SNAPSHOT_CLONE, 0x2B)
- OSD_ACT_V2(RESTORE_PARTITION_FROM_SNAPSHOT, 0x2C)
- OSD_ACT_V2(READ_MAP, 0x31)
- OSD_ACT_V2(READ_MAPS_COMPARE, 0x32)
- OSD_ACT_V1_V2(PERFORM_SCSI_COMMAND, 0x8F7E, 0x8F7C)
- OSD_ACT_V1_V2(SCSI_TASK_MANAGEMENT, 0x8F7F, 0x8F7D)
-
- };
- struct osd_attributes_list_attrid {
- __be32 attr_page;
- __be32 attr_id;
- } __packed;
- struct osdv1_attributes_list_element {
- __be32 attr_page;
- __be32 attr_id;
- __be16 attr_bytes;
- u8 attr_val[0];
- } __packed;
- struct osdv2_attributes_list_element {
- __be32 attr_page;
- __be32 attr_id;
- u8 reserved[6];
- __be16 attr_bytes;
- u8 attr_val[0];
- } __packed;
- enum {
- OSDv1_ATTRIBUTES_ELEM_ALIGN = 1,
- OSD_ATTRIBUTES_ELEM_ALIGN = 8,
- };
- enum {
- OSD_ATTR_LIST_ALL_PAGES = 0xFFFFFFFF,
- OSD_ATTR_LIST_ALL_IN_PAGE = 0xFFFFFFFF,
- };
- static inline unsigned osdv1_attr_list_elem_size(unsigned len)
- {
- return ALIGN(len + sizeof(struct osdv1_attributes_list_element),
- OSDv1_ATTRIBUTES_ELEM_ALIGN);
- }
- static inline unsigned osdv2_attr_list_elem_size(unsigned len)
- {
- return ALIGN(len + sizeof(struct osdv2_attributes_list_element),
- OSD_ATTRIBUTES_ELEM_ALIGN);
- }
- enum osd_attr_list_types {
- OSD_ATTR_LIST_GET = 0x1,
- OSD_ATTR_LIST_SET_RETRIEVE = 0x9,
- OSD_V2_ATTR_LIST_MULTIPLE = 0xE,
- OSD_V1_ATTR_LIST_CREATE_MULTIPLE = 0xF,
- };
- struct osd_attributes_list_multi_header {
- __be64 object_id;
- u8 object_type;
- u8 reserved[5];
- __be16 list_bytes;
-
- };
- struct osdv1_attributes_list_header {
- u8 type;
- u8 pad;
- __be16 list_bytes;
-
- } __packed;
- static inline unsigned osdv1_list_size(struct osdv1_attributes_list_header *h)
- {
- return be16_to_cpu(h->list_bytes);
- }
- struct osdv2_attributes_list_header {
- u8 type;
- u8 pad[3];
- __be32 list_bytes;
-
- } __packed;
- static inline unsigned osdv2_list_size(struct osdv2_attributes_list_header *h)
- {
- return be32_to_cpu(h->list_bytes);
- }
- enum {
- OSD_OBJ_ID_LIST_PAR = 0x1,
- OSD_OBJ_ID_LIST_LSTCHG = 0x2,
- };
- struct osd_obj_id_list {
- __be64 list_bytes;
- __be64 continuation_id;
- __be32 list_identifier;
- u8 pad[3];
- u8 root_lstchg;
- __be64 object_ids[0];
- } __packed;
- static inline bool osd_is_obj_list_done(struct osd_obj_id_list *list,
- bool *is_changed)
- {
- *is_changed = (0 != (list->root_lstchg & OSD_OBJ_ID_LIST_LSTCHG));
- return 0 != list->continuation_id;
- }
- struct osd_data_out_integrity_info {
- __be64 data_bytes;
- __be64 set_attributes_bytes;
- __be64 get_attributes_bytes;
- __u8 integrity_check_value[OSD_CRYPTO_KEYID_SIZE];
- } __packed;
- static inline int osd_data_out_integrity_info_sizeof(bool is_ver1)
- {
- return sizeof(struct osd_data_out_integrity_info) -
- (is_ver1 * (OSDv2_CRYPTO_KEYID_SIZE - OSDv1_CRYPTO_KEYID_SIZE));
- }
- struct osd_data_in_integrity_info {
- __be64 data_bytes;
- __be64 retrieved_attributes_bytes;
- __u8 integrity_check_value[OSD_CRYPTO_KEYID_SIZE];
- } __packed;
- static inline int osd_data_in_integrity_info_sizeof(bool is_ver1)
- {
- return sizeof(struct osd_data_in_integrity_info) -
- (is_ver1 * (OSDv2_CRYPTO_KEYID_SIZE - OSDv1_CRYPTO_KEYID_SIZE));
- }
- struct osd_timestamp {
- u8 time[6];
- } __packed;
- struct osd_key_identifier {
- u8 id[7];
- } __packed;
- enum {
- OSD_SEC_CAP_FORMAT_NO_CAPS = 0,
- OSD_SEC_CAP_FORMAT_VER1 = 1,
- OSD_SEC_CAP_FORMAT_VER2 = 2,
- };
- enum {
- OSD_SEC_NOSEC = 0,
- OSD_SEC_CAPKEY = 1,
- OSD_SEC_CMDRSP = 2,
- OSD_SEC_ALLDATA = 3,
- };
- enum object_type {
- OSD_SEC_OBJ_ROOT = 0x1,
- OSD_SEC_OBJ_PARTITION = 0x2,
- OSD_SEC_OBJ_COLLECTION = 0x40,
- OSD_SEC_OBJ_USER = 0x80,
- };
- enum osd_capability_bit_masks {
- OSD_SEC_CAP_APPEND = BIT(0),
- OSD_SEC_CAP_OBJ_MGMT = BIT(1),
- OSD_SEC_CAP_REMOVE = BIT(2),
- OSD_SEC_CAP_CREATE = BIT(3),
- OSD_SEC_CAP_SET_ATTR = BIT(4),
- OSD_SEC_CAP_GET_ATTR = BIT(5),
- OSD_SEC_CAP_WRITE = BIT(6),
- OSD_SEC_CAP_READ = BIT(7),
- OSD_SEC_CAP_NONE1 = BIT(8),
- OSD_SEC_CAP_NONE2 = BIT(9),
- OSD_SEC_GBL_REM = BIT(10),
- OSD_SEC_CAP_QUERY = BIT(11),
- OSD_SEC_CAP_M_OBJECT = BIT(12),
- OSD_SEC_CAP_POL_SEC = BIT(13),
- OSD_SEC_CAP_GLOBAL = BIT(14),
- OSD_SEC_CAP_DEV_MGMT = BIT(15),
- };
- enum {
- OSD_SEC_OBJ_DESC_NONE = 0,
- OSD_SEC_OBJ_DESC_OBJ = 1 << 4,
- OSD_SEC_OBJ_DESC_PAR = 2 << 4,
- OSD_SEC_OBJ_DESC_COL = 3 << 4,
- };
- struct osd_capability_head {
- u8 format;
- u8 integrity_algorithm__key_version;
- u8 security_method;
- u8 reserved1;
- struct osd_timestamp expiration_time;
- u8 audit[20];
- u8 discriminator[12];
- struct osd_timestamp object_created_time;
- u8 object_type;
- u8 permissions_bit_mask[5];
- u8 reserved2;
- u8 object_descriptor_type;
- } __packed;
- struct osdv1_cap_object_descriptor {
- union {
- struct {
- __be32 policy_access_tag;
- __be64 allowed_partition_id;
- __be64 allowed_object_id;
- __be32 reserved;
- } __packed obj_desc;
- u8 object_descriptor[24];
- };
- } __packed;
- struct osd_cap_object_descriptor {
- union {
- struct {
- __be32 allowed_attributes_access;
- __be32 policy_access_tag;
- __be16 boot_epoch;
- u8 reserved[6];
- __be64 allowed_partition_id;
- __be64 allowed_object_id;
- __be64 allowed_range_length;
- __be64 allowed_range_start;
- } __packed obj_desc;
- u8 object_descriptor[48];
- };
- } __packed;
- struct osdv1_capability {
- struct osd_capability_head h;
- struct osdv1_cap_object_descriptor od;
- } __packed;
- struct osd_capability {
- struct osd_capability_head h;
- struct osd_cap_object_descriptor od;
- } __packed;
- static inline void osd_sec_set_caps(struct osd_capability_head *cap,
- u16 bit_mask)
- {
-
- put_unaligned_le16(bit_mask, &cap->permissions_bit_mask);
- }
- enum osd_continuation_segment_format {
- CDB_CONTINUATION_FORMAT_V2 = 0x01,
- };
- struct osd_continuation_segment_header {
- u8 format;
- u8 reserved1;
- __be16 service_action;
- __be32 reserved2;
- u8 integrity_check[OSDv2_CRYPTO_KEYID_SIZE];
- } __packed;
- enum osd_continuation_descriptor_type {
- NO_MORE_DESCRIPTORS = 0x0000,
- SCATTER_GATHER_LIST = 0x0001,
- QUERY_LIST = 0x0002,
- USER_OBJECT = 0x0003,
- COPY_USER_OBJECT_SOURCE = 0x0101,
- EXTENSION_CAPABILITIES = 0xFFEE
- };
- struct osd_continuation_descriptor_header {
- __be16 type;
- u8 reserved;
- u8 pad_length;
- __be32 length;
- } __packed;
- struct osd_sg_list_entry {
- __be64 offset;
- __be64 len;
- };
- struct osd_sg_continuation_descriptor {
- struct osd_continuation_descriptor_header hdr;
- struct osd_sg_list_entry entries[];
- };
- #endif
|