/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Author(s)......: Holger Smolinski <Holger.Smolinski@de.ibm.com>
 *                  Horst Hummel <Horst.Hummel@de.ibm.com>
 * Bugreports.to..: <Linux390@de.ibm.com>
 * Copyright IBM Corp. 1999, 2000
 *
 */

#ifndef DASD_ECKD_H
#define DASD_ECKD_H

/*****************************************************************************
 * SECTION: CCW Definitions
 ****************************************************************************/
#define DASD_ECKD_CCW_NOP                0x03
#define DASD_ECKD_CCW_WRITE              0x05
#define DASD_ECKD_CCW_READ               0x06
#define DASD_ECKD_CCW_WRITE_HOME_ADDRESS 0x09
#define DASD_ECKD_CCW_READ_HOME_ADDRESS  0x0a
#define DASD_ECKD_CCW_WRITE_KD           0x0d
#define DASD_ECKD_CCW_READ_KD            0x0e
#define DASD_ECKD_CCW_ERASE              0x11
#define DASD_ECKD_CCW_READ_COUNT         0x12
#define DASD_ECKD_CCW_SLCK               0x14
#define DASD_ECKD_CCW_WRITE_RECORD_ZERO  0x15
#define DASD_ECKD_CCW_READ_RECORD_ZERO   0x16
#define DASD_ECKD_CCW_WRITE_CKD          0x1d
#define DASD_ECKD_CCW_READ_CKD           0x1e
#define DASD_ECKD_CCW_PSF                0x27
#define DASD_ECKD_CCW_SNID               0x34
#define DASD_ECKD_CCW_RSSD               0x3e
#define DASD_ECKD_CCW_LOCATE_RECORD      0x47
#define DASD_ECKD_CCW_LOCATE_RECORD_EXT  0x4b
#define DASD_ECKD_CCW_SNSS               0x54
#define DASD_ECKD_CCW_DEFINE_EXTENT      0x63
#define DASD_ECKD_CCW_WRITE_MT           0x85
#define DASD_ECKD_CCW_READ_MT            0x86
#define DASD_ECKD_CCW_WRITE_KD_MT        0x8d
#define DASD_ECKD_CCW_READ_KD_MT         0x8e
#define DASD_ECKD_CCW_READ_COUNT_MT      0x92
#define DASD_ECKD_CCW_RELEASE            0x94
#define DASD_ECKD_CCW_WRITE_FULL_TRACK   0x95
#define DASD_ECKD_CCW_READ_CKD_MT        0x9e
#define DASD_ECKD_CCW_WRITE_CKD_MT       0x9d
#define DASD_ECKD_CCW_WRITE_TRACK_DATA   0xA5
#define DASD_ECKD_CCW_READ_TRACK_DATA    0xA6
#define DASD_ECKD_CCW_RESERVE            0xB4
#define DASD_ECKD_CCW_READ_TRACK         0xDE
#define DASD_ECKD_CCW_PFX                0xE7
#define DASD_ECKD_CCW_PFX_READ           0xEA
#define DASD_ECKD_CCW_RSCK               0xF9
#define DASD_ECKD_CCW_RCD                0xFA
#define DASD_ECKD_CCW_DSO                0xF7

/* Define Subsystem Function / Orders */
#define DSO_ORDER_RAS                    0x81

/*
 * Perform Subsystem Function / Orders
 */
#define PSF_ORDER_PRSSD                  0x18
#define PSF_ORDER_CUIR_RESPONSE          0x1A
#define PSF_ORDER_SSC                    0x1D

/*
 * Perform Subsystem Function / Sub-Orders
 */
#define PSF_SUBORDER_QHA                 0x1C /* Query Host Access */
#define PSF_SUBORDER_PPRCEQ              0x50 /* PPRC Extended Query */
#define PSF_SUBORDER_VSQ                 0x52 /* Volume Storage Query */
#define PSF_SUBORDER_LCQ                 0x53 /* Logical Configuration Query */

/*
 * PPRC Extended Query Scopes
 */
#define PPRCEQ_SCOPE_4                   0x04 /* Scope 4 for PPRC Extended Query */

/*
 * CUIR response condition codes
 */
#define PSF_CUIR_INVALID                 0x00
#define PSF_CUIR_COMPLETED               0x01
#define PSF_CUIR_NOT_SUPPORTED           0x02
#define PSF_CUIR_ERROR_IN_REQ            0x03
#define PSF_CUIR_DENIED                  0x04
#define PSF_CUIR_LAST_PATH               0x05
#define PSF_CUIR_DEVICE_ONLINE           0x06
#define PSF_CUIR_VARY_FAILURE            0x07
#define PSF_CUIR_SOFTWARE_FAILURE        0x08
#define PSF_CUIR_NOT_RECOGNIZED          0x09

/*
 * CUIR codes
 */
#define CUIR_QUIESCE                     0x01
#define CUIR_RESUME                      0x02

/*
 * Out-of-space (OOS) Codes
 */
#define REPO_WARN                        0x01
#define REPO_EXHAUST                     0x02
#define POOL_WARN                        0x03
#define POOL_EXHAUST                     0x04
#define REPO_RELIEVE                     0x05
#define POOL_RELIEVE                     0x06

/*
 * attention message definitions
 */
#define ATTENTION_LENGTH_CUIR            0x0e
#define ATTENTION_FORMAT_CUIR            0x01
#define ATTENTION_LENGTH_OOS             0x10
#define ATTENTION_FORMAT_OOS             0x06

#define DASD_ECKD_PG_GROUPED             0x10

/*
 * Size that is reported for large volumes in the old 16-bit no_cyl field
 */
#define LV_COMPAT_CYL 0xFFFE


#define FCX_MAX_DATA_FACTOR 65536
#define DASD_ECKD_RCD_DATA_SIZE 256

#define DASD_ECKD_PATH_THRHLD            256
#define DASD_ECKD_PATH_INTERVAL          300

/*
 * Maximum number of blocks to be chained
 */
#define DASD_ECKD_MAX_BLOCKS             190
#define DASD_ECKD_MAX_BLOCKS_RAW         256

/*****************************************************************************
 * SECTION: Type Definitions
 ****************************************************************************/

struct eckd_count {
        __u16 cyl;
        __u16 head;
        __u8 record;
        __u8 kl;
        __u16 dl;
} __attribute__ ((packed));

struct ch_t {
        __u16 cyl;
        __u16 head;
} __attribute__ ((packed));

struct chr_t {
        __u16 cyl;
        __u16 head;
        __u8 record;
} __attribute__ ((packed));

struct DE_eckd_data {
        struct {
                unsigned char perm:2;   /* Permissions on this extent */
                unsigned char reserved:1;
                unsigned char seek:2;   /* Seek control */
                unsigned char auth:2;   /* Access authorization */
                unsigned char pci:1;    /* PCI Fetch mode */
        } __attribute__ ((packed)) mask;
        struct {
                unsigned char mode:2;   /* Architecture mode */
                unsigned char ckd:1;    /* CKD Conversion */
                unsigned char operation:3;      /* Operation mode */
                unsigned char cfw:1;    /* Cache fast write */
                unsigned char dfw:1;    /* DASD fast write */
        } __attribute__ ((packed)) attributes;
        __u16 blk_size;         /* Blocksize */
        __u16 fast_write_id;
        __u8 ga_additional;     /* Global Attributes Additional */
        __u8 ga_extended;       /* Global Attributes Extended   */
        struct ch_t beg_ext;
        struct ch_t end_ext;
        unsigned long ep_sys_time; /* Ext Parameter - System Time Stamp */
        __u8 ep_format;        /* Extended Parameter format byte       */
        __u8 ep_prio;          /* Extended Parameter priority I/O byte */
        __u8 ep_reserved1;     /* Extended Parameter Reserved          */
        __u8 ep_rec_per_track; /* Number of records on a track         */
        __u8 ep_reserved[4];   /* Extended Parameter Reserved          */
} __attribute__ ((packed));

struct LO_eckd_data {
        struct {
                unsigned char orientation:2;
                unsigned char operation:6;
        } __attribute__ ((packed)) operation;
        struct {
                unsigned char last_bytes_used:1;
                unsigned char reserved:6;
                unsigned char read_count_suffix:1;
        } __attribute__ ((packed)) auxiliary;
        __u8 unused;
        __u8 count;
        struct ch_t seek_addr;
        struct chr_t search_arg;
        __u8 sector;
        __u16 length;
} __attribute__ ((packed));

struct LRE_eckd_data {
        struct {
                unsigned char orientation:2;
                unsigned char operation:6;
        } __attribute__ ((packed)) operation;
        struct {
                unsigned char length_valid:1;
                unsigned char length_scope:1;
                unsigned char imbedded_ccw_valid:1;
                unsigned char check_bytes:2;
                unsigned char imbedded_count_valid:1;
                unsigned char reserved:1;
                unsigned char read_count_suffix:1;
        } __attribute__ ((packed)) auxiliary;
        __u8 imbedded_ccw;
        __u8 count;
        struct ch_t seek_addr;
        struct chr_t search_arg;
        __u8 sector;
        __u16 length;
        __u8 imbedded_count;
        __u8 extended_operation;
        __u16 extended_parameter_length;
        __u8 extended_parameter[];
} __attribute__ ((packed));

/* Prefix data for format 0x00 and 0x01 */
struct PFX_eckd_data {
        unsigned char format;
        struct {
                unsigned char define_extent:1;
                unsigned char time_stamp:1;
                unsigned char verify_base:1;
                unsigned char hyper_pav:1;
                unsigned char reserved:4;
        } __attribute__ ((packed)) validity;
        __u8 base_address;
        __u8 aux;
        __u8 base_lss;
        __u8 reserved[7];
        struct DE_eckd_data define_extent;
        struct LRE_eckd_data locate_record;
} __attribute__ ((packed));

struct dasd_eckd_characteristics {
        __u16 cu_type;
        struct {
                unsigned char support:2;
                unsigned char async:1;
                unsigned char reserved:1;
                unsigned char cache_info:1;
                unsigned char model:3;
        } __attribute__ ((packed)) cu_model;
        __u16 dev_type;
        __u8 dev_model;
        struct {
                unsigned char mult_burst:1;
                unsigned char RT_in_LR:1;
                unsigned char reserved1:1;
                unsigned char RD_IN_LR:1;
                unsigned char reserved2:4;
                unsigned char reserved3:8;
                unsigned char defect_wr:1;
                unsigned char XRC_supported:1;
                unsigned char PPRC_enabled:1;
                unsigned char striping:1;
                unsigned char reserved5:4;
                unsigned char cfw:1;
                unsigned char reserved6:2;
                unsigned char cache:1;
                unsigned char dual_copy:1;
                unsigned char dfw:1;
                unsigned char reset_alleg:1;
                unsigned char sense_down:1;
        } __attribute__ ((packed)) facilities;
        __u8 dev_class;
        __u8 unit_type;
        __u16 no_cyl;
        __u16 trk_per_cyl;
        __u8 sec_per_trk;
        __u8 byte_per_track[3];
        __u16 home_bytes;
        __u8 formula;
        union {
                struct {
                        __u8 f1;
                        __u16 f2;
                        __u16 f3;
                } __attribute__ ((packed)) f_0x01;
                struct {
                        __u8 f1;
                        __u8 f2;
                        __u8 f3;
                        __u8 f4;
                        __u8 f5;
                } __attribute__ ((packed)) f_0x02;
        } __attribute__ ((packed)) factors;
        __u16 first_alt_trk;
        __u16 no_alt_trk;
        __u16 first_dia_trk;
        __u16 no_dia_trk;
        __u16 first_sup_trk;
        __u16 no_sup_trk;
        __u8 MDR_ID;
        __u8 OBR_ID;
        __u8 director;
        __u8 rd_trk_set;
        __u16 max_rec_zero;
        __u8 reserved1;
        __u8 RWANY_in_LR;
        __u8 factor6;
        __u8 factor7;
        __u8 factor8;
        __u8 reserved2[3];
        __u8 reserved3[6];
        __u32 long_no_cyl;
} __attribute__ ((packed));

/* elements of the configuration data */
struct dasd_ned {
        struct {
                __u8 identifier:2;
                __u8 token_id:1;
                __u8 sno_valid:1;
                __u8 subst_sno:1;
                __u8 recNED:1;
                __u8 emuNED:1;
                __u8 reserved:1;
        } __attribute__ ((packed)) flags;
        __u8 descriptor;
        __u8 dev_class;
        __u8 reserved;
        __u8 dev_type[6];
        __u8 dev_model[3];
        __u8 HDA_manufacturer[3];
        struct {
                __u8 HDA_location[2];
                __u8 HDA_seqno[12];
        } serial;
        __u8 ID;
        __u8 unit_addr;
} __attribute__ ((packed));

struct dasd_sneq {
        struct {
                __u8 identifier:2;
                __u8 reserved:6;
        } __attribute__ ((packed)) flags;
        __u8 res1;
        __u16 format;
        __u8 res2[4];           /* byte  4- 7 */
        __u8 sua_flags;         /* byte  8    */
        __u8 base_unit_addr;    /* byte  9    */
        __u8 res3[22];          /* byte 10-31 */
} __attribute__ ((packed));

struct vd_sneq {
        struct {
                __u8 identifier:2;
                __u8 reserved:6;
        } __attribute__ ((packed)) flags;
        __u8 res1;
        __u16 format;
        __u8 res2[4];   /* byte  4- 7 */
        __u8 uit[16];   /* byte  8-23 */
        __u8 res3[8];   /* byte 24-31 */
} __attribute__ ((packed));

struct dasd_gneq {
        struct {
                __u8 identifier:2;
                __u8 reserved:6;
        } __attribute__ ((packed)) flags;
        __u8 record_selector;
        __u8 reserved[4];
        struct {
                __u8 value:2;
                __u8 number:6;
        } __attribute__ ((packed)) timeout;
        __u8 reserved3;
        __u16 subsystemID;
        __u8 reserved2[22];
} __attribute__ ((packed));

struct dasd_rssd_features {
        char feature[256];
} __attribute__((packed));

struct dasd_rssd_messages {
        __u16 length;
        __u8 format;
        __u8 code;
        __u32 message_id;
        __u8 flags;
        char messages[4087];
} __packed;

/*
 * Read Subsystem Data - Volume Storage Query
 */
struct dasd_rssd_vsq {
        struct {
                __u8 tse:1;
                __u8 space_not_available:1;
                __u8 ese:1;
                __u8 unused:5;
        } __packed vol_info;
        __u8 unused1;
        __u16 extent_pool_id;
        __u8 warn_cap_limit;
        __u8 warn_cap_guaranteed;
        __u16 unused2;
        __u32 limit_capacity;
        __u32 guaranteed_capacity;
        __u32 space_allocated;
        __u32 space_configured;
        __u32 logical_capacity;
} __packed;

/*
 * Extent Pool Summary
 */
struct dasd_ext_pool_sum {
        __u16 pool_id;
        __u8 repo_warn_thrshld;
        __u8 warn_thrshld;
        struct {
                __u8 type:1;                    /* 0 - CKD / 1 - FB */
                __u8 track_space_efficient:1;
                __u8 extent_space_efficient:1;
                __u8 standard_volume:1;
                __u8 extent_size_valid:1;
                __u8 capacity_at_warnlevel:1;
                __u8 pool_oos:1;
                __u8 unused0:1;
                __u8 unused1;
        } __packed flags;
        struct {
                __u8 reserved0:1;
                __u8 size_1G:1;
                __u8 reserved1:5;
                __u8 size_16M:1;
        } __packed extent_size;
        __u8 unused;
} __packed;

/*
 * Read Subsystem Data-Response - Logical Configuration Query - Header
 */
struct dasd_rssd_lcq {
        __u16 data_length;              /* Length of data returned */
        __u16 pool_count;               /* Count of extent pools returned - Max: 448 */
        struct {
                __u8 pool_info_valid:1; /* Detailed Information valid */
                __u8 pool_id_volume:1;
                __u8 pool_id_cec:1;
                __u8 unused0:5;
                __u8 unused1;
        } __packed header_flags;
        char sfi_type[6];               /* Storage Facility Image Type (EBCDIC) */
        char sfi_model[3];              /* Storage Facility Image Model (EBCDIC) */
        __u8 sfi_seq_num[10];           /* Storage Facility Image Sequence Number */
        __u8 reserved[7];
        struct dasd_ext_pool_sum ext_pool_sum[448];
} __packed;

struct dasd_oos_message {
        __u16 length;
        __u8 format;
        __u8 code;
        __u8 percentage_empty;
        __u8 reserved;
        __u16 ext_pool_id;
        __u16 token;
        __u8 unused[6];
} __packed;

struct dasd_cuir_message {
        __u16 length;
        __u8 format;
        __u8 code;
        __u32 message_id;
        __u8 flags;
        __u8 neq_map[3];
        __u8 ned_map;
        __u8 record_selector;
} __packed;

struct dasd_psf_cuir_response {
        __u8 order;
        __u8 flags;
        __u8 cc;
        __u8 chpid;
        __u16 device_nr;
        __u16 reserved;
        __u32 message_id;
        __u64 system_id;
        __u8 cssid;
        __u8 ssid;
} __packed;

struct dasd_ckd_path_group_entry {
        __u8 status_flags;
        __u8 pgid[11];
        __u8 sysplex_name[8];
        __u32 timestamp;
        __u32 cylinder;
        __u8 reserved[4];
} __packed;

struct dasd_ckd_host_information {
        __u8 access_flags;
        __u8 entry_size;
        __u16 entry_count;
        __u8 entry[16390];
} __packed;

struct dasd_psf_query_host_access {
        __u8 access_flag;
        __u8 version;
        __u16 CKD_length;
        __u16 SCSI_length;
        __u8 unused[10];
        __u8 host_access_information[16394];
} __packed;

/*
 * Perform Subsystem Function - Prepare for Read Subsystem Data
 */
struct dasd_psf_prssd_data {
        unsigned char order;
        unsigned char flags;
        unsigned char reserved1;
        unsigned char reserved2;
        unsigned char lss;
        unsigned char volume;
        unsigned char suborder;
        unsigned char varies[5];
} __attribute__ ((packed));

/*
 * Perform Subsystem Function - Set Subsystem Characteristics
 */
struct dasd_psf_ssc_data {
        unsigned char order;
        unsigned char flags;
        unsigned char cu_type[4];
        unsigned char suborder;
        unsigned char reserved[59];
} __attribute__((packed));

/* Maximum number of extents for a single Release Allocated Space command */
#define DASD_ECKD_RAS_EXTS_MAX          110U

struct dasd_dso_ras_ext_range {
        struct ch_t beg_ext;
        struct ch_t end_ext;
} __packed;

/*
 * Define Subsystem Operation - Release Allocated Space
 */
struct dasd_dso_ras_data {
        __u8 order;
        struct {
                __u8 message:1;         /* Must be zero */
                __u8 reserved1:2;
                __u8 vol_type:1;        /* 0 - CKD/FBA, 1 - FB */
                __u8 reserved2:4;
        } __packed flags;
        /* Operation Flags to specify scope */
        struct {
                __u8 reserved1:2;
                /* Release Space by Extent */
                __u8 by_extent:1;       /* 0 - entire volume, 1 - specified extents */
                __u8 guarantee_init:1;
                __u8 force_release:1;   /* Internal - will be ignored */
                __u16 reserved2:11;
        } __packed op_flags;
        __u8 lss;
        __u8 dev_addr;
        __u32 reserved1;
        __u8 reserved2[10];
        __u16 nr_exts;                  /* Defines number of ext_scope - max 110 */
        __u16 reserved3;
} __packed;


/*
 * some structures and definitions for alias handling
 */
struct dasd_unit_address_configuration {
        struct {
                char ua_type;
                char base_ua;
        } unit[256];
} __attribute__((packed));


#define MAX_DEVICES_PER_LCU 256

/* flags on the LCU  */
#define NEED_UAC_UPDATE  0x01
#define UPDATE_PENDING  0x02

enum pavtype {NO_PAV, BASE_PAV, HYPER_PAV};


struct alias_root {
        struct list_head serverlist;
        spinlock_t lock;
};

struct alias_server {
        struct list_head server;
        struct dasd_uid uid;
        struct list_head lculist;
};

struct summary_unit_check_work_data {
        char reason;
        struct dasd_device *device;
        struct work_struct worker;
};

struct read_uac_work_data {
        struct dasd_device *device;
        struct delayed_work dwork;
};

struct alias_lcu {
        struct list_head lcu;
        struct dasd_uid uid;
        enum pavtype pav;
        char flags;
        spinlock_t lock;
        struct list_head grouplist;
        struct list_head active_devices;
        struct list_head inactive_devices;
        struct dasd_unit_address_configuration *uac;
        struct summary_unit_check_work_data suc_data;
        struct read_uac_work_data ruac_data;
        struct dasd_ccw_req *rsu_cqr;
        struct completion lcu_setup;
};

struct alias_pav_group {
        struct list_head group;
        struct dasd_uid uid;
        struct alias_lcu *lcu;
        struct list_head baselist;
        struct list_head aliaslist;
        struct dasd_device *next;
};

struct dasd_conf_data {
        struct dasd_ned neds[5];
        u8 reserved[64];
        struct dasd_gneq gneq;
} __packed;

struct dasd_conf {
        u8 *data;
        int len;
        /* pointers to specific parts in the conf_data */
        struct dasd_ned *ned;
        struct dasd_sneq *sneq;
        struct vd_sneq *vdsneq;
        struct dasd_gneq *gneq;
};

struct dasd_eckd_private {
        struct dasd_eckd_characteristics rdc_data;
        struct dasd_conf conf;

        struct eckd_count count_area[5];
        int init_cqr_status;
        int uses_cdl;
        struct attrib_data_t attrib;    /* e.g. cache operations */
        struct dasd_rssd_features features;
        struct dasd_rssd_vsq vsq;
        struct dasd_ext_pool_sum eps;
        u32 real_cyl;

        /* alias management */
        struct dasd_uid uid;
        struct alias_pav_group *pavgroup;
        struct alias_lcu *lcu;
        int count;

        u32 fcx_max_data;
        char suc_reason;
};



int dasd_alias_make_device_known_to_lcu(struct dasd_device *);
void dasd_alias_disconnect_device_from_lcu(struct dasd_device *);
int dasd_alias_add_device(struct dasd_device *);
int dasd_alias_remove_device(struct dasd_device *);
struct dasd_device *dasd_alias_get_start_dev(struct dasd_device *);
void dasd_alias_handle_summary_unit_check(struct work_struct *);
void dasd_eckd_reset_ccw_to_base_io(struct dasd_ccw_req *);
int dasd_alias_update_add_device(struct dasd_device *);
#endif                          /* DASD_ECKD_H */