1*4882a593Smuzhiyun // SPDX-License-Identifier: Zlib
2*4882a593Smuzhiyun #ifndef DFLTCC_H
3*4882a593Smuzhiyun #define DFLTCC_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include "../zlib_deflate/defutil.h"
6*4882a593Smuzhiyun #include <asm/facility.h>
7*4882a593Smuzhiyun #include <asm/setup.h>
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun /*
10*4882a593Smuzhiyun * Tuning parameters.
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun #define DFLTCC_LEVEL_MASK 0x2 /* DFLTCC compression for level 1 only */
13*4882a593Smuzhiyun #define DFLTCC_LEVEL_MASK_DEBUG 0x3fe /* DFLTCC compression for all levels */
14*4882a593Smuzhiyun #define DFLTCC_BLOCK_SIZE 1048576
15*4882a593Smuzhiyun #define DFLTCC_FIRST_FHT_BLOCK_SIZE 4096
16*4882a593Smuzhiyun #define DFLTCC_DHT_MIN_SAMPLE_SIZE 4096
17*4882a593Smuzhiyun #define DFLTCC_RIBM 0
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define DFLTCC_FACILITY 151
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun * Parameter Block for Query Available Functions.
23*4882a593Smuzhiyun */
24*4882a593Smuzhiyun struct dfltcc_qaf_param {
25*4882a593Smuzhiyun char fns[16];
26*4882a593Smuzhiyun char reserved1[8];
27*4882a593Smuzhiyun char fmts[2];
28*4882a593Smuzhiyun char reserved2[6];
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun static_assert(sizeof(struct dfltcc_qaf_param) == 32);
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun #define DFLTCC_FMT0 0
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun /*
36*4882a593Smuzhiyun * Parameter Block for Generate Dynamic-Huffman Table, Compress and Expand.
37*4882a593Smuzhiyun */
38*4882a593Smuzhiyun struct dfltcc_param_v0 {
39*4882a593Smuzhiyun uint16_t pbvn; /* Parameter-Block-Version Number */
40*4882a593Smuzhiyun uint8_t mvn; /* Model-Version Number */
41*4882a593Smuzhiyun uint8_t ribm; /* Reserved for IBM use */
42*4882a593Smuzhiyun unsigned reserved32 : 31;
43*4882a593Smuzhiyun unsigned cf : 1; /* Continuation Flag */
44*4882a593Smuzhiyun uint8_t reserved64[8];
45*4882a593Smuzhiyun unsigned nt : 1; /* New Task */
46*4882a593Smuzhiyun unsigned reserved129 : 1;
47*4882a593Smuzhiyun unsigned cvt : 1; /* Check Value Type */
48*4882a593Smuzhiyun unsigned reserved131 : 1;
49*4882a593Smuzhiyun unsigned htt : 1; /* Huffman-Table Type */
50*4882a593Smuzhiyun unsigned bcf : 1; /* Block-Continuation Flag */
51*4882a593Smuzhiyun unsigned bcc : 1; /* Block Closing Control */
52*4882a593Smuzhiyun unsigned bhf : 1; /* Block Header Final */
53*4882a593Smuzhiyun unsigned reserved136 : 1;
54*4882a593Smuzhiyun unsigned reserved137 : 1;
55*4882a593Smuzhiyun unsigned dhtgc : 1; /* DHT Generation Control */
56*4882a593Smuzhiyun unsigned reserved139 : 5;
57*4882a593Smuzhiyun unsigned reserved144 : 5;
58*4882a593Smuzhiyun unsigned sbb : 3; /* Sub-Byte Boundary */
59*4882a593Smuzhiyun uint8_t oesc; /* Operation-Ending-Supplemental Code */
60*4882a593Smuzhiyun unsigned reserved160 : 12;
61*4882a593Smuzhiyun unsigned ifs : 4; /* Incomplete-Function Status */
62*4882a593Smuzhiyun uint16_t ifl; /* Incomplete-Function Length */
63*4882a593Smuzhiyun uint8_t reserved192[8];
64*4882a593Smuzhiyun uint8_t reserved256[8];
65*4882a593Smuzhiyun uint8_t reserved320[4];
66*4882a593Smuzhiyun uint16_t hl; /* History Length */
67*4882a593Smuzhiyun unsigned reserved368 : 1;
68*4882a593Smuzhiyun uint16_t ho : 15; /* History Offset */
69*4882a593Smuzhiyun uint32_t cv; /* Check Value */
70*4882a593Smuzhiyun unsigned eobs : 15; /* End-of-block Symbol */
71*4882a593Smuzhiyun unsigned reserved431: 1;
72*4882a593Smuzhiyun uint8_t eobl : 4; /* End-of-block Length */
73*4882a593Smuzhiyun unsigned reserved436 : 12;
74*4882a593Smuzhiyun unsigned reserved448 : 4;
75*4882a593Smuzhiyun uint16_t cdhtl : 12; /* Compressed-Dynamic-Huffman Table
76*4882a593Smuzhiyun Length */
77*4882a593Smuzhiyun uint8_t reserved464[6];
78*4882a593Smuzhiyun uint8_t cdht[288];
79*4882a593Smuzhiyun uint8_t reserved[32];
80*4882a593Smuzhiyun uint8_t csb[1152];
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun static_assert(sizeof(struct dfltcc_param_v0) == 1536);
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun #define CVT_CRC32 0
86*4882a593Smuzhiyun #define CVT_ADLER32 1
87*4882a593Smuzhiyun #define HTT_FIXED 0
88*4882a593Smuzhiyun #define HTT_DYNAMIC 1
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun /*
91*4882a593Smuzhiyun * Extension of inflate_state and deflate_state for DFLTCC.
92*4882a593Smuzhiyun */
93*4882a593Smuzhiyun struct dfltcc_state {
94*4882a593Smuzhiyun struct dfltcc_param_v0 param; /* Parameter block */
95*4882a593Smuzhiyun struct dfltcc_qaf_param af; /* Available functions */
96*4882a593Smuzhiyun uLong level_mask; /* Levels on which to use DFLTCC */
97*4882a593Smuzhiyun uLong block_size; /* New block each X bytes */
98*4882a593Smuzhiyun uLong block_threshold; /* New block after total_in > X */
99*4882a593Smuzhiyun uLong dht_threshold; /* New block only if avail_in >= X */
100*4882a593Smuzhiyun char msg[64]; /* Buffer for strm->msg */
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun /* Resides right after inflate_state or deflate_state */
104*4882a593Smuzhiyun #define GET_DFLTCC_STATE(state) ((struct dfltcc_state *)((state) + 1))
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun /* External functions */
107*4882a593Smuzhiyun int dfltcc_can_deflate(z_streamp strm);
108*4882a593Smuzhiyun int dfltcc_deflate(z_streamp strm,
109*4882a593Smuzhiyun int flush,
110*4882a593Smuzhiyun block_state *result);
111*4882a593Smuzhiyun void dfltcc_reset(z_streamp strm, uInt size);
112*4882a593Smuzhiyun int dfltcc_can_inflate(z_streamp strm);
113*4882a593Smuzhiyun typedef enum {
114*4882a593Smuzhiyun DFLTCC_INFLATE_CONTINUE,
115*4882a593Smuzhiyun DFLTCC_INFLATE_BREAK,
116*4882a593Smuzhiyun DFLTCC_INFLATE_SOFTWARE,
117*4882a593Smuzhiyun } dfltcc_inflate_action;
118*4882a593Smuzhiyun dfltcc_inflate_action dfltcc_inflate(z_streamp strm,
119*4882a593Smuzhiyun int flush, int *ret);
is_dfltcc_enabled(void)120*4882a593Smuzhiyun static inline int is_dfltcc_enabled(void)
121*4882a593Smuzhiyun {
122*4882a593Smuzhiyun return (zlib_dfltcc_support != ZLIB_DFLTCC_DISABLED &&
123*4882a593Smuzhiyun test_facility(DFLTCC_FACILITY));
124*4882a593Smuzhiyun }
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun #define DEFLATE_RESET_HOOK(strm) \
127*4882a593Smuzhiyun dfltcc_reset((strm), sizeof(deflate_state))
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun #define DEFLATE_HOOK dfltcc_deflate
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun #define DEFLATE_NEED_CHECKSUM(strm) (!dfltcc_can_deflate((strm)))
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun #define DEFLATE_DFLTCC_ENABLED() is_dfltcc_enabled()
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun #define INFLATE_RESET_HOOK(strm) \
136*4882a593Smuzhiyun dfltcc_reset((strm), sizeof(struct inflate_state))
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun #define INFLATE_TYPEDO_HOOK(strm, flush) \
139*4882a593Smuzhiyun if (dfltcc_can_inflate((strm))) { \
140*4882a593Smuzhiyun dfltcc_inflate_action action; \
141*4882a593Smuzhiyun \
142*4882a593Smuzhiyun RESTORE(); \
143*4882a593Smuzhiyun action = dfltcc_inflate((strm), (flush), &ret); \
144*4882a593Smuzhiyun LOAD(); \
145*4882a593Smuzhiyun if (action == DFLTCC_INFLATE_CONTINUE) \
146*4882a593Smuzhiyun break; \
147*4882a593Smuzhiyun else if (action == DFLTCC_INFLATE_BREAK) \
148*4882a593Smuzhiyun goto inf_leave; \
149*4882a593Smuzhiyun }
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun #define INFLATE_NEED_CHECKSUM(strm) (!dfltcc_can_inflate((strm)))
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun #define INFLATE_NEED_UPDATEWINDOW(strm) (!dfltcc_can_inflate((strm)))
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun #endif /* DFLTCC_H */
156