Total coverage: 502014 (27%)of 1872410 


















































































































































































































    8 
























    1 















































































































































































































































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
/* SPDX-License-Identifier: GPL-2.0-or-later */
/* FS-Cache tracepoints
 *
 * Copyright (C) 2021 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 */
#undef TRACE_SYSTEM
#define TRACE_SYSTEM fscache

#if !defined(_TRACE_FSCACHE_H) || defined(TRACE_HEADER_MULTI_READ)
#define _TRACE_FSCACHE_H

#include <linux/fscache.h>
#include <linux/tracepoint.h>

/*
 * Define enums for tracing information.
 */
#ifndef __FSCACHE_DECLARE_TRACE_ENUMS_ONCE_ONLY
#define __FSCACHE_DECLARE_TRACE_ENUMS_ONCE_ONLY

enum fscache_cache_trace {
        fscache_cache_collision,
        fscache_cache_get_acquire,
        fscache_cache_new_acquire,
        fscache_cache_put_alloc_volume,
        fscache_cache_put_cache,
        fscache_cache_put_prep_failed,
        fscache_cache_put_relinquish,
        fscache_cache_put_volume,
};

enum fscache_volume_trace {
        fscache_volume_collision,
        fscache_volume_get_cookie,
        fscache_volume_get_create_work,
        fscache_volume_get_hash_collision,
        fscache_volume_get_withdraw,
        fscache_volume_free,
        fscache_volume_new_acquire,
        fscache_volume_put_cookie,
        fscache_volume_put_create_work,
        fscache_volume_put_hash_collision,
        fscache_volume_put_relinquish,
        fscache_volume_put_withdraw,
        fscache_volume_see_create_work,
        fscache_volume_see_hash_wake,
        fscache_volume_wait_create_work,
};

enum fscache_cookie_trace {
        fscache_cookie_collision,
        fscache_cookie_discard,
        fscache_cookie_failed,
        fscache_cookie_get_attach_object,
        fscache_cookie_get_end_access,
        fscache_cookie_get_hash_collision,
        fscache_cookie_get_inval_work,
        fscache_cookie_get_lru,
        fscache_cookie_get_use_work,
        fscache_cookie_new_acquire,
        fscache_cookie_put_hash_collision,
        fscache_cookie_put_lru,
        fscache_cookie_put_object,
        fscache_cookie_put_over_queued,
        fscache_cookie_put_relinquish,
        fscache_cookie_put_withdrawn,
        fscache_cookie_put_work,
        fscache_cookie_see_active,
        fscache_cookie_see_lru_discard,
        fscache_cookie_see_lru_discard_clear,
        fscache_cookie_see_lru_do_one,
        fscache_cookie_see_relinquish,
        fscache_cookie_see_withdraw,
        fscache_cookie_see_work,
};

enum fscache_active_trace {
        fscache_active_use,
        fscache_active_use_modify,
        fscache_active_unuse,
};

enum fscache_access_trace {
        fscache_access_acquire_volume,
        fscache_access_acquire_volume_end,
        fscache_access_cache_pin,
        fscache_access_cache_unpin,
        fscache_access_invalidate_cookie,
        fscache_access_invalidate_cookie_end,
        fscache_access_io_end,
        fscache_access_io_not_live,
        fscache_access_io_read,
        fscache_access_io_resize,
        fscache_access_io_wait,
        fscache_access_io_write,
        fscache_access_lookup_cookie,
        fscache_access_lookup_cookie_end,
        fscache_access_lookup_cookie_end_failed,
        fscache_access_relinquish_volume,
        fscache_access_relinquish_volume_end,
        fscache_access_unlive,
};

#endif

/*
 * Declare tracing information enums and their string mappings for display.
 */
#define fscache_cache_traces                                                \
        EM(fscache_cache_collision,                "*COLLIDE*")                \
        EM(fscache_cache_get_acquire,                "GET acq  ")                \
        EM(fscache_cache_new_acquire,                "NEW acq  ")                \
        EM(fscache_cache_put_alloc_volume,        "PUT alvol")                \
        EM(fscache_cache_put_cache,                "PUT cache")                \
        EM(fscache_cache_put_prep_failed,        "PUT pfail")                \
        EM(fscache_cache_put_relinquish,        "PUT relnq")                \
        E_(fscache_cache_put_volume,                "PUT vol  ")

#define fscache_volume_traces                                                \
        EM(fscache_volume_collision,                "*COLLIDE*")                \
        EM(fscache_volume_get_cookie,                "GET cook ")                \
        EM(fscache_volume_get_create_work,        "GET creat")                \
        EM(fscache_volume_get_hash_collision,        "GET hcoll")                \
        EM(fscache_volume_get_withdraw,                "GET withd")            \
        EM(fscache_volume_free,                        "FREE     ")                \
        EM(fscache_volume_new_acquire,                "NEW acq  ")                \
        EM(fscache_volume_put_cookie,                "PUT cook ")                \
        EM(fscache_volume_put_create_work,        "PUT creat")                \
        EM(fscache_volume_put_hash_collision,        "PUT hcoll")                \
        EM(fscache_volume_put_relinquish,        "PUT relnq")                \
        EM(fscache_volume_put_withdraw,                "PUT withd")            \
        EM(fscache_volume_see_create_work,        "SEE creat")                \
        EM(fscache_volume_see_hash_wake,        "SEE hwake")                \
        E_(fscache_volume_wait_create_work,        "WAIT crea")

#define fscache_cookie_traces                                                \
        EM(fscache_cookie_collision,                "*COLLIDE*")                \
        EM(fscache_cookie_discard,                "DISCARD  ")                \
        EM(fscache_cookie_failed,                "FAILED   ")                \
        EM(fscache_cookie_get_attach_object,        "GET attch")                \
        EM(fscache_cookie_get_hash_collision,        "GET hcoll")                \
        EM(fscache_cookie_get_end_access,        "GQ  endac")                \
        EM(fscache_cookie_get_inval_work,        "GQ  inval")                \
        EM(fscache_cookie_get_lru,                "GET lru  ")                \
        EM(fscache_cookie_get_use_work,                "GQ  use  ")                \
        EM(fscache_cookie_new_acquire,                "NEW acq  ")                \
        EM(fscache_cookie_put_hash_collision,        "PUT hcoll")                \
        EM(fscache_cookie_put_lru,                "PUT lru  ")                \
        EM(fscache_cookie_put_object,                "PUT obj  ")                \
        EM(fscache_cookie_put_over_queued,        "PQ  overq")                \
        EM(fscache_cookie_put_relinquish,        "PUT relnq")                \
        EM(fscache_cookie_put_withdrawn,        "PUT wthdn")                \
        EM(fscache_cookie_put_work,                "PQ  work ")                \
        EM(fscache_cookie_see_active,                "-   activ")                \
        EM(fscache_cookie_see_lru_discard,        "-   x-lru")                \
        EM(fscache_cookie_see_lru_discard_clear,"-   lrudc")            \
        EM(fscache_cookie_see_lru_do_one,        "-   lrudo")                \
        EM(fscache_cookie_see_relinquish,        "-   x-rlq")                \
        EM(fscache_cookie_see_withdraw,                "-   x-wth")                \
        E_(fscache_cookie_see_work,                "-   work ")

#define fscache_active_traces                \
        EM(fscache_active_use,                        "USE          ")        \
        EM(fscache_active_use_modify,                "USE-m        ")        \
        E_(fscache_active_unuse,                "UNUSE        ")

#define fscache_access_traces                \
        EM(fscache_access_acquire_volume,        "BEGIN acq_vol")        \
        EM(fscache_access_acquire_volume_end,        "END   acq_vol")        \
        EM(fscache_access_cache_pin,                "PIN   cache  ")        \
        EM(fscache_access_cache_unpin,                "UNPIN cache  ")        \
        EM(fscache_access_invalidate_cookie,        "BEGIN inval  ")        \
        EM(fscache_access_invalidate_cookie_end,"END   inval  ")        \
        EM(fscache_access_io_end,                "END   io     ")        \
        EM(fscache_access_io_not_live,                "END   io_notl")        \
        EM(fscache_access_io_read,                "BEGIN io_read")        \
        EM(fscache_access_io_resize,                "BEGIN io_resz")        \
        EM(fscache_access_io_wait,                "WAIT  io     ")        \
        EM(fscache_access_io_write,                "BEGIN io_writ")        \
        EM(fscache_access_lookup_cookie,        "BEGIN lookup ")        \
        EM(fscache_access_lookup_cookie_end,        "END   lookup ")        \
        EM(fscache_access_lookup_cookie_end_failed,"END   lookupf")        \
        EM(fscache_access_relinquish_volume,        "BEGIN rlq_vol")        \
        EM(fscache_access_relinquish_volume_end,"END   rlq_vol")        \
        E_(fscache_access_unlive,                "END   unlive ")

/*
 * Export enum symbols via userspace.
 */
#undef EM
#undef E_
#define EM(a, b) TRACE_DEFINE_ENUM(a);
#define E_(a, b) TRACE_DEFINE_ENUM(a);

fscache_cache_traces;
fscache_volume_traces;
fscache_cookie_traces;
fscache_access_traces;

/*
 * Now redefine the EM() and E_() macros to map the enums to the strings that
 * will be printed in the output.
 */
#undef EM
#undef E_
#define EM(a, b)        { a, b },
#define E_(a, b)        { a, b }


TRACE_EVENT(fscache_cache,
            TP_PROTO(unsigned int cache_debug_id,
                     int usage,
                     enum fscache_cache_trace where),

            TP_ARGS(cache_debug_id, usage, where),

            TP_STRUCT__entry(
                    __field(unsigned int,                cache                )
                    __field(int,                        usage                )
                    __field(enum fscache_cache_trace,        where                )
                             ),

            TP_fast_assign(
                    __entry->cache        = cache_debug_id;
                    __entry->usage        = usage;
                    __entry->where        = where;
                           ),

            TP_printk("C=%08x %s r=%d",
                      __entry->cache,
                      __print_symbolic(__entry->where, fscache_cache_traces),
                      __entry->usage)
            );

TRACE_EVENT(fscache_volume,
            TP_PROTO(unsigned int volume_debug_id,
                     int usage,
                     enum fscache_volume_trace where),

            TP_ARGS(volume_debug_id, usage, where),

            TP_STRUCT__entry(
                    __field(unsigned int,                volume                )
                    __field(int,                        usage                )
                    __field(enum fscache_volume_trace,        where                )
                             ),

            TP_fast_assign(
                    __entry->volume        = volume_debug_id;
                    __entry->usage        = usage;
                    __entry->where        = where;
                           ),

            TP_printk("V=%08x %s u=%d",
                      __entry->volume,
                      __print_symbolic(__entry->where, fscache_volume_traces),
                      __entry->usage)
            );

TRACE_EVENT(fscache_cookie,
            TP_PROTO(unsigned int cookie_debug_id,
                     int ref,
                     enum fscache_cookie_trace where),

            TP_ARGS(cookie_debug_id, ref, where),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(int,                        ref                )
                    __field(enum fscache_cookie_trace,        where                )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie_debug_id;
                    __entry->ref        = ref;
                    __entry->where        = where;
                           ),

            TP_printk("c=%08x %s r=%d",
                      __entry->cookie,
                      __print_symbolic(__entry->where, fscache_cookie_traces),
                      __entry->ref)
            );

TRACE_EVENT(fscache_active,
            TP_PROTO(unsigned int cookie_debug_id,
                     int ref,
                     int n_active,
                     int n_accesses,
                     enum fscache_active_trace why),

            TP_ARGS(cookie_debug_id, ref, n_active, n_accesses, why),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(int,                        ref                )
                    __field(int,                        n_active        )
                    __field(int,                        n_accesses        )
                    __field(enum fscache_active_trace,        why                )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie_debug_id;
                    __entry->ref        = ref;
                    __entry->n_active        = n_active;
                    __entry->n_accesses        = n_accesses;
                    __entry->why        = why;
                           ),

            TP_printk("c=%08x %s r=%d a=%d c=%d",
                      __entry->cookie,
                      __print_symbolic(__entry->why, fscache_active_traces),
                      __entry->ref,
                      __entry->n_accesses,
                      __entry->n_active)
            );

TRACE_EVENT(fscache_access_cache,
            TP_PROTO(unsigned int cache_debug_id,
                     int ref,
                     int n_accesses,
                     enum fscache_access_trace why),

            TP_ARGS(cache_debug_id, ref, n_accesses, why),

            TP_STRUCT__entry(
                    __field(unsigned int,                cache                )
                    __field(int,                        ref                )
                    __field(int,                        n_accesses        )
                    __field(enum fscache_access_trace,        why                )
                             ),

            TP_fast_assign(
                    __entry->cache        = cache_debug_id;
                    __entry->ref        = ref;
                    __entry->n_accesses        = n_accesses;
                    __entry->why        = why;
                           ),

            TP_printk("C=%08x %s r=%d a=%d",
                      __entry->cache,
                      __print_symbolic(__entry->why, fscache_access_traces),
                      __entry->ref,
                      __entry->n_accesses)
            );

TRACE_EVENT(fscache_access_volume,
            TP_PROTO(unsigned int volume_debug_id,
                     unsigned int cookie_debug_id,
                     int ref,
                     int n_accesses,
                     enum fscache_access_trace why),

            TP_ARGS(volume_debug_id, cookie_debug_id, ref, n_accesses, why),

            TP_STRUCT__entry(
                    __field(unsigned int,                volume                )
                    __field(unsigned int,                cookie                )
                    __field(int,                        ref                )
                    __field(int,                        n_accesses        )
                    __field(enum fscache_access_trace,        why                )
                             ),

            TP_fast_assign(
                    __entry->volume        = volume_debug_id;
                    __entry->cookie        = cookie_debug_id;
                    __entry->ref        = ref;
                    __entry->n_accesses        = n_accesses;
                    __entry->why        = why;
                           ),

            TP_printk("V=%08x c=%08x %s r=%d a=%d",
                      __entry->volume,
                      __entry->cookie,
                      __print_symbolic(__entry->why, fscache_access_traces),
                      __entry->ref,
                      __entry->n_accesses)
            );

TRACE_EVENT(fscache_access,
            TP_PROTO(unsigned int cookie_debug_id,
                     int ref,
                     int n_accesses,
                     enum fscache_access_trace why),

            TP_ARGS(cookie_debug_id, ref, n_accesses, why),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(int,                        ref                )
                    __field(int,                        n_accesses        )
                    __field(enum fscache_access_trace,        why                )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie_debug_id;
                    __entry->ref        = ref;
                    __entry->n_accesses        = n_accesses;
                    __entry->why        = why;
                           ),

            TP_printk("c=%08x %s r=%d a=%d",
                      __entry->cookie,
                      __print_symbolic(__entry->why, fscache_access_traces),
                      __entry->ref,
                      __entry->n_accesses)
            );

TRACE_EVENT(fscache_acquire,
            TP_PROTO(struct fscache_cookie *cookie),

            TP_ARGS(cookie),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(unsigned int,                volume                )
                    __field(int,                        v_ref                )
                    __field(int,                        v_n_cookies        )
                             ),

            TP_fast_assign(
                    __entry->cookie                = cookie->debug_id;
                    __entry->volume                = cookie->volume->debug_id;
                    __entry->v_ref                = refcount_read(&cookie->volume->ref);
                    __entry->v_n_cookies        = atomic_read(&cookie->volume->n_cookies);
                           ),

            TP_printk("c=%08x V=%08x vr=%d vc=%d",
                      __entry->cookie,
                      __entry->volume, __entry->v_ref, __entry->v_n_cookies)
            );

TRACE_EVENT(fscache_relinquish,
            TP_PROTO(struct fscache_cookie *cookie, bool retire),

            TP_ARGS(cookie, retire),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(unsigned int,                volume                )
                    __field(int,                        ref                )
                    __field(int,                        n_active        )
                    __field(u8,                                flags                )
                    __field(bool,                        retire                )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie->debug_id;
                    __entry->volume        = cookie->volume->debug_id;
                    __entry->ref        = refcount_read(&cookie->ref);
                    __entry->n_active        = atomic_read(&cookie->n_active);
                    __entry->flags        = cookie->flags;
                    __entry->retire        = retire;
                           ),

            TP_printk("c=%08x V=%08x r=%d U=%d f=%02x rt=%u",
                      __entry->cookie, __entry->volume, __entry->ref,
                      __entry->n_active, __entry->flags, __entry->retire)
            );

TRACE_EVENT(fscache_invalidate,
            TP_PROTO(struct fscache_cookie *cookie, loff_t new_size),

            TP_ARGS(cookie, new_size),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(loff_t,                        new_size        )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie->debug_id;
                    __entry->new_size        = new_size;
                           ),

            TP_printk("c=%08x sz=%llx",
                      __entry->cookie, __entry->new_size)
            );

TRACE_EVENT(fscache_resize,
            TP_PROTO(struct fscache_cookie *cookie, loff_t new_size),

            TP_ARGS(cookie, new_size),

            TP_STRUCT__entry(
                    __field(unsigned int,                cookie                )
                    __field(loff_t,                        old_size        )
                    __field(loff_t,                        new_size        )
                             ),

            TP_fast_assign(
                    __entry->cookie        = cookie->debug_id;
                    __entry->old_size        = cookie->object_size;
                    __entry->new_size        = new_size;
                           ),

            TP_printk("c=%08x os=%08llx sz=%08llx",
                      __entry->cookie,
                      __entry->old_size,
                      __entry->new_size)
            );

#endif /* _TRACE_FSCACHE_H */

/* This part must be outside protection */
#include <trace/define_trace.h>














































































































































































































































































































































































































































































    1 









    1 
    1 
    1 










    1 















    1 


















    1 

    1 
    1 




















































































































    1 




    1 


    1 





























































































































    1 
    1 
















































































































































































































































































































































































































































































































































    2 
















    2 


    2 


    6 












    2 


    2 


    6 












    6 




    2 


    2 


    6 
















    4 


    4 


    4 





    4 








    1 


    1 





















    4 






    7 


    9 
    3 

    6 




    8 


























    6 
    6 





    2 
    6 

    6 




    6 
    4 




    2 


    6 
    6 

   10 
    2 




























    5 






    5 
    5 








    5 
    1 



    4 

    5 



































































































































































































   13 





   13 
    5 

    5 










    5 

    5 




   13 









   13 
   13 


    4 

   13 
    8 


   13 
   12 
   13 
   13 

   13 

    1 



   13 



    3 


   13 
    4 



    6 



    6 


    6 


    2 

    5 


    5 











    6 



    6 
    6 








   11 



   11 
   11 



    5 




   11 

    6 

   10 



   10 









   10 
    5 

    5 
   10 












    2 


    2 
    2 



    2 
    2 


    2 




    2 
    2 
    2 

    2 







    5 




    6 
   13 











    5 


    2 

    1 














    1 
    1 










    1 


    3 

    2 



    1 

    1 


    1 






    1 



    1 
    2 



    2 
    2 
    2 

    2 






    4 
    5 







   51 

















1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
// SPDX-License-Identifier: GPL-2.0
/*
 * IPVS         An implementation of the IP virtual server support for the
 *              LINUX operating system.  IPVS is now implemented as a module
 *              over the NetFilter framework. IPVS can be used to build a
 *              high-performance and highly available server based on a
 *              cluster of servers.
 *
 * Version 1,   is capable of handling both version 0 and 1 messages.
 *              Version 0 is the plain old format.
 *              Note Version 0 receivers will just drop Ver 1 messages.
 *              Version 1 is capable of handle IPv6, Persistence data,
 *              time-outs, and firewall marks.
 *              In ver.1 "ip_vs_sync_conn_options" will be sent in netw. order.
 *              Ver. 0 can be turned on by sysctl -w net.ipv4.vs.sync_version=0
 *
 * Definitions  Message: is a complete datagram
 *              Sync_conn: is a part of a Message
 *              Param Data is an option to a Sync_conn.
 *
 * Authors:     Wensong Zhang <wensong@linuxvirtualserver.org>
 *
 * ip_vs_sync:  sync connection info from master load balancer to backups
 *              through multicast
 *
 * Changes:
 *        Alexandre Cassen        :        Added master & backup support at a time.
 *        Alexandre Cassen        :        Added SyncID support for incoming sync
 *                                        messages filtering.
 *        Justin Ossevoort        :        Fix endian problem on sync message size.
 *        Hans Schillstrom        :        Added Version 1: i.e. IPv6,
 *                                        Persistence support, fwmark and time-out.
 */

#define pr_fmt(fmt) "IPVS: " fmt

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/inetdevice.h>
#include <linux/net.h>
#include <linux/completion.h>
#include <linux/delay.h>
#include <linux/skbuff.h>
#include <linux/in.h>
#include <linux/igmp.h>                 /* for ip_mc_join_group */
#include <linux/udp.h>
#include <linux/err.h>
#include <linux/kthread.h>
#include <linux/wait.h>
#include <linux/kernel.h>
#include <linux/sched/signal.h>

#include <linux/unaligned.h>                /* Used for ntoh_seq and hton_seq */

#include <net/ip.h>
#include <net/sock.h>

#include <net/ip_vs.h>

#define IP_VS_SYNC_GROUP 0xe0000051    /* multicast addr - 224.0.0.81 */
#define IP_VS_SYNC_PORT  8848          /* multicast port */

#define SYNC_PROTO_VER  1                /* Protocol version in header */

static struct lock_class_key __ipvs_sync_key;
/*
 *        IPVS sync connection entry
 *        Version 0, i.e. original version.
 */
struct ip_vs_sync_conn_v0 {
        __u8                        reserved;

        /* Protocol, addresses and port numbers */
        __u8                        protocol;       /* Which protocol (TCP/UDP) */
        __be16                        cport;
        __be16                  vport;
        __be16                  dport;
        __be32                  caddr;          /* client address */
        __be32                  vaddr;          /* virtual address */
        __be32                  daddr;          /* destination address */

        /* Flags and state transition */
        __be16                  flags;          /* status flags */
        __be16                  state;          /* state info */

        /* The sequence options start here */
};

struct ip_vs_sync_conn_options {
        struct ip_vs_seq        in_seq;         /* incoming seq. struct */
        struct ip_vs_seq        out_seq;        /* outgoing seq. struct */
};

/*
     Sync Connection format (sync_conn)

       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |    Type       |    Protocol   | Ver.  |        Size           |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                             Flags                             |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |            State              |         cport                 |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |            vport              |         dport                 |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                             fwmark                            |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                             timeout  (in sec.)                |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                              ...                              |
      |                        IP-Addresses  (v4 or v6)               |
      |                              ...                              |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  Optional Parameters.
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      | Param. Type    | Param. Length |   Param. data                |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
      |                              ...                              |
      |                               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                               | Param Type    | Param. Length |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                           Param  data                         |
      |         Last Param data should be padded for 32 bit alignment |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/

/*
 *  Type 0, IPv4 sync connection format
 */
struct ip_vs_sync_v4 {
        __u8                        type;
        __u8                        protocol;        /* Which protocol (TCP/UDP) */
        __be16                        ver_size;        /* Version msb 4 bits */
        /* Flags and state transition */
        __be32                        flags;                /* status flags */
        __be16                        state;                /* state info         */
        /* Protocol, addresses and port numbers */
        __be16                        cport;
        __be16                        vport;
        __be16                        dport;
        __be32                        fwmark;                /* Firewall mark from skb */
        __be32                        timeout;        /* cp timeout */
        __be32                        caddr;                /* client address */
        __be32                        vaddr;                /* virtual address */
        __be32                        daddr;                /* destination address */
        /* The sequence options start here */
        /* PE data padded to 32bit alignment after seq. options */
};
/*
 * Type 2 messages IPv6
 */
struct ip_vs_sync_v6 {
        __u8                        type;
        __u8                        protocol;        /* Which protocol (TCP/UDP) */
        __be16                        ver_size;        /* Version msb 4 bits */
        /* Flags and state transition */
        __be32                        flags;                /* status flags */
        __be16                        state;                /* state info         */
        /* Protocol, addresses and port numbers */
        __be16                        cport;
        __be16                        vport;
        __be16                        dport;
        __be32                        fwmark;                /* Firewall mark from skb */
        __be32                        timeout;        /* cp timeout */
        struct in6_addr                caddr;                /* client address */
        struct in6_addr                vaddr;                /* virtual address */
        struct in6_addr                daddr;                /* destination address */
        /* The sequence options start here */
        /* PE data padded to 32bit alignment after seq. options */
};

union ip_vs_sync_conn {
        struct ip_vs_sync_v4        v4;
        struct ip_vs_sync_v6        v6;
};

/* Bits in Type field in above */
#define STYPE_INET6                0
#define STYPE_F_INET6                (1 << STYPE_INET6)

#define SVER_SHIFT                12                /* Shift to get version */
#define SVER_MASK                0x0fff                /* Mask to strip version */

#define IPVS_OPT_SEQ_DATA        1
#define IPVS_OPT_PE_DATA        2
#define IPVS_OPT_PE_NAME        3
#define IPVS_OPT_PARAM                7

#define IPVS_OPT_F_SEQ_DATA        (1 << (IPVS_OPT_SEQ_DATA-1))
#define IPVS_OPT_F_PE_DATA        (1 << (IPVS_OPT_PE_DATA-1))
#define IPVS_OPT_F_PE_NAME        (1 << (IPVS_OPT_PE_NAME-1))
#define IPVS_OPT_F_PARAM        (1 << (IPVS_OPT_PARAM-1))

struct ip_vs_sync_thread_data {
        struct task_struct *task;
        struct netns_ipvs *ipvs;
        struct socket *sock;
        char *buf;
        int id;
};

/* Version 0 definition of packet sizes */
#define SIMPLE_CONN_SIZE  (sizeof(struct ip_vs_sync_conn_v0))
#define FULL_CONN_SIZE  \
(sizeof(struct ip_vs_sync_conn_v0) + sizeof(struct ip_vs_sync_conn_options))


/*
  The master mulitcasts messages (Datagrams) to the backup load balancers
  in the following format.

 Version 1:
  Note, first byte should be Zero, so ver 0 receivers will drop the packet.

       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |      0        |    SyncID     |            Size               |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |  Count Conns  |    Version    |    Reserved, set to Zero      |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                                                               |
      |                    IPVS Sync Connection (1)                   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                            .                                  |
      ~                            .                                  ~
      |                            .                                  |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                                                               |
      |                    IPVS Sync Connection (n)                   |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

 Version 0 Header
       0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |  Count Conns  |    SyncID     |            Size               |
      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      |                    IPVS Sync Connection (1)                   |
*/

/* Version 0 header */
struct ip_vs_sync_mesg_v0 {
        __u8                    nr_conns;
        __u8                    syncid;
        __be16                  size;

        /* ip_vs_sync_conn entries start here */
};

/* Version 1 header */
struct ip_vs_sync_mesg {
        __u8                        reserved;        /* must be zero */
        __u8                        syncid;
        __be16                        size;
        __u8                        nr_conns;
        __s8                        version;        /* SYNC_PROTO_VER  */
        __u16                        spare;
        /* ip_vs_sync_conn entries start here */
};

union ipvs_sockaddr {
        struct sockaddr_in        in;
        struct sockaddr_in6        in6;
};

struct ip_vs_sync_buff {
        struct list_head        list;
        unsigned long           firstuse;

        /* pointers for the message data */
        struct ip_vs_sync_mesg  *mesg;
        unsigned char           *head;
        unsigned char           *end;
};

/*
 * Copy of struct ip_vs_seq
 * From unaligned network order to aligned host order
 */
static void ntoh_seq(struct ip_vs_seq *no, struct ip_vs_seq *ho)
{
        memset(ho, 0, sizeof(*ho));
        ho->init_seq       = get_unaligned_be32(&no->init_seq);
        ho->delta          = get_unaligned_be32(&no->delta);
        ho->previous_delta = get_unaligned_be32(&no->previous_delta);
}

/*
 * Copy of struct ip_vs_seq
 * From Aligned host order to unaligned network order
 */
static void hton_seq(struct ip_vs_seq *ho, struct ip_vs_seq *no)
{
        put_unaligned_be32(ho->init_seq, &no->init_seq);
        put_unaligned_be32(ho->delta, &no->delta);
        put_unaligned_be32(ho->previous_delta, &no->previous_delta);
}

static inline struct ip_vs_sync_buff *
sb_dequeue(struct netns_ipvs *ipvs, struct ipvs_master_sync_state *ms)
{
        struct ip_vs_sync_buff *sb;

        spin_lock_bh(&ipvs->sync_lock);
        if (list_empty(&ms->sync_queue)) {
                sb = NULL;
                __set_current_state(TASK_INTERRUPTIBLE);
        } else {
                sb = list_entry(ms->sync_queue.next, struct ip_vs_sync_buff,
                                list);
                list_del(&sb->list);
                ms->sync_queue_len--;
                if (!ms->sync_queue_len)
                        ms->sync_queue_delay = 0;
        }
        spin_unlock_bh(&ipvs->sync_lock);

        return sb;
}

/*
 * Create a new sync buffer for Version 1 proto.
 */
static inline struct ip_vs_sync_buff *
ip_vs_sync_buff_create(struct netns_ipvs *ipvs, unsigned int len)
{
        struct ip_vs_sync_buff *sb;

        if (!(sb=kmalloc_obj(struct ip_vs_sync_buff, GFP_ATOMIC)))
                return NULL;

        len = max_t(unsigned int, len + sizeof(struct ip_vs_sync_mesg),
                    ipvs->mcfg.sync_maxlen);
        sb->mesg = kmalloc(len, GFP_ATOMIC);
        if (!sb->mesg) {
                kfree(sb);
                return NULL;
        }
        sb->mesg->reserved = 0;  /* old nr_conns i.e. must be zero now */
        sb->mesg->version = SYNC_PROTO_VER;
        sb->mesg->syncid = ipvs->mcfg.syncid;
        sb->mesg->size = htons(sizeof(struct ip_vs_sync_mesg));
        sb->mesg->nr_conns = 0;
        sb->mesg->spare = 0;
        sb->head = (unsigned char *)sb->mesg + sizeof(struct ip_vs_sync_mesg);
        sb->end = (unsigned char *)sb->mesg + len;

        sb->firstuse = jiffies;
        return sb;
}

static inline void ip_vs_sync_buff_release(struct ip_vs_sync_buff *sb)
{
        kfree(sb->mesg);
        kfree(sb);
}

static inline void sb_queue_tail(struct netns_ipvs *ipvs,
                                 struct ipvs_master_sync_state *ms)
{
        struct ip_vs_sync_buff *sb = ms->sync_buff;

        spin_lock(&ipvs->sync_lock);
        if (ipvs->sync_state & IP_VS_STATE_MASTER &&
            ms->sync_queue_len < sysctl_sync_qlen_max(ipvs)) {
                if (!ms->sync_queue_len)
                        schedule_delayed_work(&ms->master_wakeup_work,
                                              max(IPVS_SYNC_SEND_DELAY, 1));
                ms->sync_queue_len++;
                list_add_tail(&sb->list, &ms->sync_queue);
                if ((++ms->sync_queue_delay) == IPVS_SYNC_WAKEUP_RATE) {
                        int id = (int)(ms - ipvs->ms);

                        wake_up_process(ipvs->master_tinfo[id].task);
                }
        } else
                ip_vs_sync_buff_release(sb);
        spin_unlock(&ipvs->sync_lock);
}

/*
 *        Get the current sync buffer if it has been created for more
 *        than the specified time or the specified time is zero.
 */
static inline struct ip_vs_sync_buff *
get_curr_sync_buff(struct netns_ipvs *ipvs, struct ipvs_master_sync_state *ms,
                   unsigned long time)
{
        struct ip_vs_sync_buff *sb;

        spin_lock_bh(&ipvs->sync_buff_lock);
        sb = ms->sync_buff;
        if (sb && time_after_eq(jiffies - sb->firstuse, time)) {
                ms->sync_buff = NULL;
                __set_current_state(TASK_RUNNING);
        } else
                sb = NULL;
        spin_unlock_bh(&ipvs->sync_buff_lock);
        return sb;
}

static inline int
select_master_thread_id(struct netns_ipvs *ipvs, struct ip_vs_conn *cp)
{
        return ((long) cp >> (1 + ilog2(sizeof(*cp)))) & ipvs->threads_mask;
}

/*
 * Create a new sync buffer for Version 0 proto.
 */
static inline struct ip_vs_sync_buff *
ip_vs_sync_buff_create_v0(struct netns_ipvs *ipvs, unsigned int len)
{
        struct ip_vs_sync_buff *sb;
        struct ip_vs_sync_mesg_v0 *mesg;

        if (!(sb=kmalloc_obj(struct ip_vs_sync_buff, GFP_ATOMIC)))
                return NULL;

        len = max_t(unsigned int, len + sizeof(struct ip_vs_sync_mesg_v0),
                    ipvs->mcfg.sync_maxlen);
        sb->mesg = kmalloc(len, GFP_ATOMIC);
        if (!sb->mesg) {
                kfree(sb);
                return NULL;
        }
        mesg = (struct ip_vs_sync_mesg_v0 *)sb->mesg;
        mesg->nr_conns = 0;
        mesg->syncid = ipvs->mcfg.syncid;
        mesg->size = htons(sizeof(struct ip_vs_sync_mesg_v0));
        sb->head = (unsigned char *)mesg + sizeof(struct ip_vs_sync_mesg_v0);
        sb->end = (unsigned char *)mesg + len;
        sb->firstuse = jiffies;
        return sb;
}

/* Check if connection is controlled by persistence */
static inline bool in_persistence(struct ip_vs_conn *cp)
{
        for (cp = cp->control; cp; cp = cp->control) {
                if (cp->flags & IP_VS_CONN_F_TEMPLATE)
                        return true;
        }
        return false;
}

/* Check if conn should be synced.
 * pkts: conn packets, use sysctl_sync_threshold to avoid packet check
 * - (1) sync_refresh_period: reduce sync rate. Additionally, retry
 *        sync_retries times with period of sync_refresh_period/8
 * - (2) if both sync_refresh_period and sync_period are 0 send sync only
 *        for state changes or only once when pkts matches sync_threshold
 * - (3) templates: rate can be reduced only with sync_refresh_period or
 *        with (2)
 */
static int ip_vs_sync_conn_needed(struct netns_ipvs *ipvs,
                                  struct ip_vs_conn *cp, int pkts)
{
        unsigned long orig = READ_ONCE(cp->sync_endtime);
        unsigned long now = jiffies;
        unsigned long n = (now + cp->timeout) & ~3UL;
        unsigned int sync_refresh_period;
        int sync_period;
        int force;

        /* Check if we sync in current state */
        if (unlikely(cp->flags & IP_VS_CONN_F_TEMPLATE))
                force = 0;
        else if (unlikely(sysctl_sync_persist_mode(ipvs) && in_persistence(cp)))
                return 0;
        else if (likely(cp->protocol == IPPROTO_TCP)) {
                if (!((1 << cp->state) &
                      ((1 << IP_VS_TCP_S_ESTABLISHED) |
                       (1 << IP_VS_TCP_S_FIN_WAIT) |
                       (1 << IP_VS_TCP_S_CLOSE) |
                       (1 << IP_VS_TCP_S_CLOSE_WAIT) |
                       (1 << IP_VS_TCP_S_TIME_WAIT))))
                        return 0;
                force = cp->state != cp->old_state;
                if (force && cp->state != IP_VS_TCP_S_ESTABLISHED)
                        goto set;
        } else if (unlikely(cp->protocol == IPPROTO_SCTP)) {
                if (!((1 << cp->state) &
                      ((1 << IP_VS_SCTP_S_ESTABLISHED) |
                       (1 << IP_VS_SCTP_S_SHUTDOWN_SENT) |
                       (1 << IP_VS_SCTP_S_SHUTDOWN_RECEIVED) |
                       (1 << IP_VS_SCTP_S_SHUTDOWN_ACK_SENT) |
                       (1 << IP_VS_SCTP_S_CLOSED))))
                        return 0;
                force = cp->state != cp->old_state;
                if (force && cp->state != IP_VS_SCTP_S_ESTABLISHED)
                        goto set;
        } else {
                /* UDP or another protocol with single state */
                force = 0;
        }

        sync_refresh_period = sysctl_sync_refresh_period(ipvs);
        if (sync_refresh_period > 0) {
                long diff = n - orig;
                long min_diff = max(cp->timeout >> 1, 10UL * HZ);

                /* Avoid sync if difference is below sync_refresh_period
                 * and below the half timeout.
                 */
                if (abs(diff) < min_t(long, sync_refresh_period, min_diff)) {
                        int retries = orig & 3;

                        if (retries >= sysctl_sync_retries(ipvs))
                                return 0;
                        if (time_before(now, orig - cp->timeout +
                                        (sync_refresh_period >> 3)))
                                return 0;
                        n |= retries + 1;
                }
        }
        sync_period = sysctl_sync_period(ipvs);
        if (sync_period > 0) {
                if (!(cp->flags & IP_VS_CONN_F_TEMPLATE) &&
                    pkts % sync_period != sysctl_sync_threshold(ipvs))
                        return 0;
        } else if (!sync_refresh_period &&
                   pkts != sysctl_sync_threshold(ipvs))
                return 0;

set:
        cp->old_state = cp->state;
        n = cmpxchg(&cp->sync_endtime, orig, n);
        return n == orig || force;
}

/*
 *      Version 0 , could be switched in by sys_ctl.
 *      Add an ip_vs_conn information into the current sync_buff.
 */
static void ip_vs_sync_conn_v0(struct netns_ipvs *ipvs, struct ip_vs_conn *cp,
                               int pkts)
{
        struct ip_vs_sync_mesg_v0 *m;
        struct ip_vs_sync_conn_v0 *s;
        struct ip_vs_sync_buff *buff;
        struct ipvs_master_sync_state *ms;
        int id;
        unsigned int len;

        if (unlikely(cp->af != AF_INET))
                return;
        /* Do not sync ONE PACKET */
        if (cp->flags & IP_VS_CONN_F_ONE_PACKET)
                return;

        if (!ip_vs_sync_conn_needed(ipvs, cp, pkts))
                return;

        spin_lock_bh(&ipvs->sync_buff_lock);
        if (!(ipvs->sync_state & IP_VS_STATE_MASTER)) {
                spin_unlock_bh(&ipvs->sync_buff_lock);
                return;
        }

        id = select_master_thread_id(ipvs, cp);
        ms = &ipvs->ms[id];
        buff = ms->sync_buff;
        len = (cp->flags & IP_VS_CONN_F_SEQ_MASK) ? FULL_CONN_SIZE :
                SIMPLE_CONN_SIZE;
        if (buff) {
                m = (struct ip_vs_sync_mesg_v0 *) buff->mesg;
                /* Send buffer if it is for v1 */
                if (buff->head + len > buff->end || !m->nr_conns) {
                        sb_queue_tail(ipvs, ms);
                        ms->sync_buff = NULL;
                        buff = NULL;
                }
        }
        if (!buff) {
                buff = ip_vs_sync_buff_create_v0(ipvs, len);
                if (!buff) {
                        spin_unlock_bh(&ipvs->sync_buff_lock);
                        pr_err("ip_vs_sync_buff_create failed.\n");
                        return;
                }
                ms->sync_buff = buff;
        }

        m = (struct ip_vs_sync_mesg_v0 *) buff->mesg;
        s = (struct ip_vs_sync_conn_v0 *) buff->head;

        /* copy members */
        s->reserved = 0;
        s->protocol = cp->protocol;
        s->cport = cp->cport;
        s->vport = cp->vport;
        s->dport = cp->dport;
        s->caddr = cp->caddr.ip;
        s->vaddr = cp->vaddr.ip;
        s->daddr = cp->daddr.ip;
        s->flags = htons(cp->flags & ~IP_VS_CONN_F_HASHED);
        s->state = htons(cp->state);
        if (cp->flags & IP_VS_CONN_F_SEQ_MASK) {
                struct ip_vs_sync_conn_options *opt =
                        (struct ip_vs_sync_conn_options *)&s[1];
                memcpy(opt, &cp->sync_conn_opt, sizeof(*opt));
        }

        m->nr_conns++;
        m->size = htons(ntohs(m->size) + len);
        buff->head += len;
        spin_unlock_bh(&ipvs->sync_buff_lock);

        /* synchronize its controller if it has */
        cp = cp->control;
        if (cp) {
                if (cp->flags & IP_VS_CONN_F_TEMPLATE)
                        pkts = atomic_inc_return(&cp->in_pkts);
                else
                        pkts = sysctl_sync_threshold(ipvs);
                ip_vs_sync_conn(ipvs, cp, pkts);
        }
}

/*
 *      Add an ip_vs_conn information into the current sync_buff.
 *      Called by ip_vs_in.
 *      Sending Version 1 messages
 */
void ip_vs_sync_conn(struct netns_ipvs *ipvs, struct ip_vs_conn *cp, int pkts)
{
        struct ip_vs_sync_mesg *m;
        union ip_vs_sync_conn *s;
        struct ip_vs_sync_buff *buff;
        struct ipvs_master_sync_state *ms;
        int id;
        __u8 *p;
        unsigned int len, pe_name_len, pad;

        /* Handle old version of the protocol */
        if (sysctl_sync_ver(ipvs) == 0) {
                ip_vs_sync_conn_v0(ipvs, cp, pkts);
                return;
        }
        /* Do not sync ONE PACKET */
        if (cp->flags & IP_VS_CONN_F_ONE_PACKET)
                goto control;
sloop:
        if (!ip_vs_sync_conn_needed(ipvs, cp, pkts))
                goto control;

        /* Sanity checks */
        pe_name_len = 0;
        if (cp->pe_data_len) {
                if (!cp->pe_data || !cp->dest) {
                        IP_VS_ERR_RL("SYNC, connection pe_data invalid\n");
                        return;
                }
                pe_name_len = strnlen(cp->pe->name, IP_VS_PENAME_MAXLEN);
        }

        spin_lock_bh(&ipvs->sync_buff_lock);
        if (!(ipvs->sync_state & IP_VS_STATE_MASTER)) {
                spin_unlock_bh(&ipvs->sync_buff_lock);
                return;
        }

        id = select_master_thread_id(ipvs, cp);
        ms = &ipvs->ms[id];

#ifdef CONFIG_IP_VS_IPV6
        if (cp->af == AF_INET6)
                len = sizeof(struct ip_vs_sync_v6);
        else
#endif
                len = sizeof(struct ip_vs_sync_v4);

        if (cp->flags & IP_VS_CONN_F_SEQ_MASK)
                len += sizeof(struct ip_vs_sync_conn_options) + 2;

        if (cp->pe_data_len)
                len += cp->pe_data_len + 2;        /* + Param hdr field */
        if (pe_name_len)
                len += pe_name_len + 2;

        /* check if there is a space for this one  */
        pad = 0;
        buff = ms->sync_buff;
        if (buff) {
                m = buff->mesg;
                pad = (4 - (size_t) buff->head) & 3;
                /* Send buffer if it is for v0 */
                if (buff->head + len + pad > buff->end || m->reserved) {
                        sb_queue_tail(ipvs, ms);
                        ms->sync_buff = NULL;
                        buff = NULL;
                        pad = 0;
                }
        }

        if (!buff) {
                buff = ip_vs_sync_buff_create(ipvs, len);
                if (!buff) {
                        spin_unlock_bh(&ipvs->sync_buff_lock);
                        pr_err("ip_vs_sync_buff_create failed.\n");
                        return;
                }
                ms->sync_buff = buff;
                m = buff->mesg;
        }

        p = buff->head;
        buff->head += pad + len;
        m->size = htons(ntohs(m->size) + pad + len);
        /* Add ev. padding from prev. sync_conn */
        while (pad--)
                *(p++) = 0;

        s = (union ip_vs_sync_conn *)p;

        /* Set message type  & copy members */
        s->v4.type = (cp->af == AF_INET6 ? STYPE_F_INET6 : 0);
        s->v4.ver_size = htons(len & SVER_MASK);        /* Version 0 */
        s->v4.flags = htonl(cp->flags & ~IP_VS_CONN_F_HASHED);
        s->v4.state = htons(cp->state);
        s->v4.protocol = cp->protocol;
        s->v4.cport = cp->cport;
        s->v4.vport = cp->vport;
        s->v4.dport = cp->dport;
        s->v4.fwmark = htonl(cp->fwmark);
        s->v4.timeout = htonl(cp->timeout / HZ);
        m->nr_conns++;

#ifdef CONFIG_IP_VS_IPV6
        if (cp->af == AF_INET6) {
                p += sizeof(struct ip_vs_sync_v6);
                s->v6.caddr = cp->caddr.in6;
                s->v6.vaddr = cp->vaddr.in6;
                s->v6.daddr = cp->daddr.in6;
        } else
#endif
        {
                p += sizeof(struct ip_vs_sync_v4);        /* options ptr */
                s->v4.caddr = cp->caddr.ip;
                s->v4.vaddr = cp->vaddr.ip;
                s->v4.daddr = cp->daddr.ip;
        }
        if (cp->flags & IP_VS_CONN_F_SEQ_MASK) {
                *(p++) = IPVS_OPT_SEQ_DATA;
                *(p++) = sizeof(struct ip_vs_sync_conn_options);
                hton_seq((struct ip_vs_seq *)p, &cp->in_seq);
                p += sizeof(struct ip_vs_seq);
                hton_seq((struct ip_vs_seq *)p, &cp->out_seq);
                p += sizeof(struct ip_vs_seq);
        }
        /* Handle pe data */
        if (cp->pe_data_len && cp->pe_data) {
                *(p++) = IPVS_OPT_PE_DATA;
                *(p++) = cp->pe_data_len;
                memcpy(p, cp->pe_data, cp->pe_data_len);
                p += cp->pe_data_len;
                if (pe_name_len) {
                        /* Add PE_NAME */
                        *(p++) = IPVS_OPT_PE_NAME;
                        *(p++) = pe_name_len;
                        memcpy(p, cp->pe->name, pe_name_len);
                        p += pe_name_len;
                }
        }

        spin_unlock_bh(&ipvs->sync_buff_lock);

control:
        /* synchronize its controller if it has */
        cp = cp->control;
        if (!cp)
                return;
        if (cp->flags & IP_VS_CONN_F_TEMPLATE)
                pkts = atomic_inc_return(&cp->in_pkts);
        else
                pkts = sysctl_sync_threshold(ipvs);
        goto sloop;
}

/*
 *  fill_param used by version 1
 */
static inline int
ip_vs_conn_fill_param_sync(struct netns_ipvs *ipvs, int af, union ip_vs_sync_conn *sc,
                           struct ip_vs_conn_param *p,
                           __u8 *pe_data, unsigned int pe_data_len,
                           __u8 *pe_name, unsigned int pe_name_len)
{
#ifdef CONFIG_IP_VS_IPV6
        if (af == AF_INET6)
                ip_vs_conn_fill_param(ipvs, af, sc->v6.protocol,
                                      (const union nf_inet_addr *)&sc->v6.caddr,
                                      sc->v6.cport,
                                      (const union nf_inet_addr *)&sc->v6.vaddr,
                                      sc->v6.vport, p);
        else
#endif
                ip_vs_conn_fill_param(ipvs, af, sc->v4.protocol,
                                      (const union nf_inet_addr *)&sc->v4.caddr,
                                      sc->v4.cport,
                                      (const union nf_inet_addr *)&sc->v4.vaddr,
                                      sc->v4.vport, p);
        /* Handle pe data */
        if (pe_data_len) {
                if (pe_name_len) {
                        char buff[IP_VS_PENAME_MAXLEN+1];

                        memcpy(buff, pe_name, pe_name_len);
                        buff[pe_name_len]=0;
                        p->pe = __ip_vs_pe_getbyname(buff);
                        if (!p->pe) {
                                IP_VS_DBG(3, "BACKUP, no %s engine found/loaded\n",
                                             buff);
                                return 1;
                        }
                } else {
                        IP_VS_ERR_RL("BACKUP, Invalid PE parameters\n");
                        return 1;
                }

                p->pe_data = kmemdup(pe_data, pe_data_len, GFP_ATOMIC);
                if (!p->pe_data) {
                        module_put(p->pe->module);
                        return -ENOMEM;
                }
                p->pe_data_len = pe_data_len;
        }
        return 0;
}

/*
 *  Connection Add / Update.
 *  Common for version 0 and 1 reception of backup sync_conns.
 *  Param: ...
 *         timeout is in sec.
 */
static void ip_vs_proc_conn(struct netns_ipvs *ipvs, struct ip_vs_conn_param *param,
                            unsigned int flags, unsigned int state,
                            unsigned int protocol, unsigned int type,
                            const union nf_inet_addr *daddr, __be16 dport,
                            unsigned long timeout, __u32 fwmark,
                            struct ip_vs_sync_conn_options *opt)
{
        struct ip_vs_dest *dest;
        struct ip_vs_conn *cp;

        if (!(flags & IP_VS_CONN_F_TEMPLATE)) {
                cp = ip_vs_conn_in_get(param);
                if (cp && ((cp->dport != dport) ||
                           !ip_vs_addr_equal(cp->daf, &cp->daddr, daddr))) {
                        if (!(flags & IP_VS_CONN_F_INACTIVE)) {
                                ip_vs_conn_expire_now(cp);
                                __ip_vs_conn_put(cp);
                                cp = NULL;
                        } else {
                                /* This is the expiration message for the
                                 * connection that was already replaced, so we
                                 * just ignore it.
                                 */
                                __ip_vs_conn_put(cp);
                                kfree(param->pe_data);
                                return;
                        }
                }
        } else {
                cp = ip_vs_ct_in_get(param);
        }

        if (cp) {
                /* Free pe_data */
                kfree(param->pe_data);

                dest = cp->dest;
                spin_lock_bh(&cp->lock);
                if ((cp->flags ^ flags) & IP_VS_CONN_F_INACTIVE &&
                    !(flags & IP_VS_CONN_F_TEMPLATE) && dest) {
                        if (flags & IP_VS_CONN_F_INACTIVE) {
                                atomic_dec(&dest->activeconns);
                                atomic_inc(&dest->inactconns);
                        } else {
                                atomic_inc(&dest->activeconns);
                                atomic_dec(&dest->inactconns);
                        }
                }
                flags &= IP_VS_CONN_F_BACKUP_UPD_MASK;
                flags |= cp->flags & ~IP_VS_CONN_F_BACKUP_UPD_MASK;
                cp->flags = flags;
                spin_unlock_bh(&cp->lock);
                if (!dest)
                        ip_vs_try_bind_dest(cp);
        } else {
                /*
                 * Find the appropriate destination for the connection.
                 * If it is not found the connection will remain unbound
                 * but still handled.
                 */
                rcu_read_lock();
                /* This function is only invoked by the synchronization
                 * code. We do not currently support heterogeneous pools
                 * with synchronization, so we can make the assumption that
                 * the svc_af is the same as the dest_af
                 */
                dest = ip_vs_find_dest(ipvs, type, type, daddr, dport,
                                       param->vaddr, param->vport, protocol,
                                       fwmark, flags);

                cp = ip_vs_conn_new(param, type, daddr, dport, flags, dest,
                                    fwmark);
                rcu_read_unlock();
                if (!cp) {
                        kfree(param->pe_data);
                        IP_VS_DBG(2, "BACKUP, add new conn. failed\n");
                        return;
                }
                if (!(flags & IP_VS_CONN_F_TEMPLATE))
                        kfree(param->pe_data);
        }

        if (opt) {
                cp->in_seq = opt->in_seq;
                cp->out_seq = opt->out_seq;
        }
        atomic_set(&cp->in_pkts, sysctl_sync_threshold(ipvs));
        cp->state = state;
        cp->old_state = cp->state;
        /*
         * For Ver 0 messages style
         *  - Not possible to recover the right timeout for templates
         *  - can not find the right fwmark
         *    virtual service. If needed, we can do it for
         *    non-fwmark persistent services.
         * Ver 1 messages style.
         *  - No problem.
         */
        if (timeout) {
                if (timeout > MAX_SCHEDULE_TIMEOUT / HZ)
                        timeout = MAX_SCHEDULE_TIMEOUT / HZ;
                cp->timeout = timeout*HZ;
        } else {
                struct ip_vs_proto_data *pd;

                pd = ip_vs_proto_data_get(ipvs, protocol);
                if (!(flags & IP_VS_CONN_F_TEMPLATE) && pd && pd->timeout_table)
                        cp->timeout = pd->timeout_table[state];
                else
                        cp->timeout = (3*60*HZ);
        }
        ip_vs_conn_put(cp);
}

/*
 *  Process received multicast message for Version 0
 */
static void ip_vs_process_message_v0(struct netns_ipvs *ipvs, const char *buffer,
                                     const size_t buflen)
{
        struct ip_vs_sync_mesg_v0 *m = (struct ip_vs_sync_mesg_v0 *)buffer;
        struct ip_vs_sync_conn_v0 *s;
        struct ip_vs_sync_conn_options *opt;
        struct ip_vs_protocol *pp;
        struct ip_vs_conn_param param;
        char *p;
        int i;

        p = (char *)buffer + sizeof(struct ip_vs_sync_mesg_v0);
        for (i=0; i<m->nr_conns; i++) {
                unsigned int flags, state;

                if (p + SIMPLE_CONN_SIZE > buffer+buflen) {
                        IP_VS_ERR_RL("BACKUP v0, bogus conn\n");
                        return;
                }
                s = (struct ip_vs_sync_conn_v0 *) p;
                flags = ntohs(s->flags) | IP_VS_CONN_F_SYNC;
                flags &= ~IP_VS_CONN_F_HASHED;
                if (flags & IP_VS_CONN_F_SEQ_MASK) {
                        opt = (struct ip_vs_sync_conn_options *)&s[1];
                        p += FULL_CONN_SIZE;
                        if (p > buffer+buflen) {
                                IP_VS_ERR_RL("BACKUP v0, Dropping buffer bogus conn options\n");
                                return;
                        }
                } else {
                        opt = NULL;
                        p += SIMPLE_CONN_SIZE;
                }

                state = ntohs(s->state);
                if (!(flags & IP_VS_CONN_F_TEMPLATE)) {
                        pp = ip_vs_proto_get(s->protocol);
                        if (!pp) {
                                IP_VS_DBG(2, "BACKUP v0, Unsupported protocol %u\n",
                                        s->protocol);
                                continue;
                        }
                        if (state >= pp->num_states) {
                                IP_VS_DBG(2, "BACKUP v0, Invalid %s state %u\n",
                                        pp->name, state);
                                continue;
                        }
                } else {
                        if (state >= IP_VS_CTPL_S_LAST)
                                IP_VS_DBG(7, "BACKUP v0, Invalid tpl state %u\n",
                                          state);
                }

                ip_vs_conn_fill_param(ipvs, AF_INET, s->protocol,
                                      (const union nf_inet_addr *)&s->caddr,
                                      s->cport,
                                      (const union nf_inet_addr *)&s->vaddr,
                                      s->vport, &param);

                /* Send timeout as Zero */
                ip_vs_proc_conn(ipvs, &param, flags, state, s->protocol, AF_INET,
                                (union nf_inet_addr *)&s->daddr, s->dport,
                                0, 0, opt);
        }
}

/*
 * Handle options
 */
static inline int ip_vs_proc_seqopt(__u8 *p, unsigned int plen,
                                    __u32 *opt_flags,
                                    struct ip_vs_sync_conn_options *opt)
{
        struct ip_vs_sync_conn_options *topt;

        topt = (struct ip_vs_sync_conn_options *)p;

        if (plen != sizeof(struct ip_vs_sync_conn_options)) {
                IP_VS_DBG(2, "BACKUP, bogus conn options length\n");
                return -EINVAL;
        }
        if (*opt_flags & IPVS_OPT_F_SEQ_DATA) {
                IP_VS_DBG(2, "BACKUP, conn options found twice\n");
                return -EINVAL;
        }
        ntoh_seq(&topt->in_seq, &opt->in_seq);
        ntoh_seq(&topt->out_seq, &opt->out_seq);
        *opt_flags |= IPVS_OPT_F_SEQ_DATA;
        return 0;
}

static int ip_vs_proc_str(__u8 *p, unsigned int plen, unsigned int *data_len,
                          __u8 **data, unsigned int maxlen,
                          __u32 *opt_flags, __u32 flag)
{
        if (plen > maxlen) {
                IP_VS_DBG(2, "BACKUP, bogus par.data len > %d\n", maxlen);
                return -EINVAL;
        }
        if (*opt_flags & flag) {
                IP_VS_DBG(2, "BACKUP, Par.data found twice 0x%x\n", flag);
                return -EINVAL;
        }
        *data_len = plen;
        *data = p;
        *opt_flags |= flag;
        return 0;
}
/*
 *   Process a Version 1 sync. connection
 */
static inline int ip_vs_proc_sync_conn(struct netns_ipvs *ipvs, __u8 *p, __u8 *msg_end)
{
        struct ip_vs_sync_conn_options opt;
        union  ip_vs_sync_conn *s;
        struct ip_vs_protocol *pp;
        struct ip_vs_conn_param param;
        __u32 flags;
        unsigned int af, state, pe_data_len=0, pe_name_len=0;
        __u8 *pe_data=NULL, *pe_name=NULL;
        __u32 opt_flags=0;
        int retc=0;

        s = (union ip_vs_sync_conn *) p;

        if (s->v6.type & STYPE_F_INET6) {
#ifdef CONFIG_IP_VS_IPV6
                af = AF_INET6;
                p += sizeof(struct ip_vs_sync_v6);
#else
                IP_VS_DBG(3,"BACKUP, IPv6 msg received, and IPVS is not compiled for IPv6\n");
                retc = 10;
                goto out;
#endif
        } else if (!s->v4.type) {
                af = AF_INET;
                p += sizeof(struct ip_vs_sync_v4);
        } else {
                return -10;
        }
        if (p > msg_end)
                return -20;

        /* Process optional params check Type & Len. */
        while (p < msg_end) {
                int ptype;
                int plen;

                if (p+2 > msg_end)
                        return -30;
                ptype = *(p++);
                plen  = *(p++);

                if (!plen || ((p + plen) > msg_end))
                        return -40;
                /* Handle seq option  p = param data */
                switch (ptype & ~IPVS_OPT_F_PARAM) {
                case IPVS_OPT_SEQ_DATA:
                        if (ip_vs_proc_seqopt(p, plen, &opt_flags, &opt))
                                return -50;
                        break;

                case IPVS_OPT_PE_DATA:
                        if (ip_vs_proc_str(p, plen, &pe_data_len, &pe_data,
                                           IP_VS_PEDATA_MAXLEN, &opt_flags,
                                           IPVS_OPT_F_PE_DATA))
                                return -60;
                        break;

                case IPVS_OPT_PE_NAME:
                        if (ip_vs_proc_str(p, plen,&pe_name_len, &pe_name,
                                           IP_VS_PENAME_MAXLEN, &opt_flags,
                                           IPVS_OPT_F_PE_NAME))
                                return -70;
                        break;

                default:
                        /* Param data mandatory ? */
                        if (!(ptype & IPVS_OPT_F_PARAM)) {
                                IP_VS_DBG(3, "BACKUP, Unknown mandatory param %d found\n",
                                          ptype & ~IPVS_OPT_F_PARAM);
                                retc = 20;
                                goto out;
                        }
                }
                p += plen;  /* Next option */
        }

        /* Get flags and Mask off unsupported */
        flags  = ntohl(s->v4.flags) & IP_VS_CONN_F_BACKUP_MASK;
        flags |= IP_VS_CONN_F_SYNC;
        state = ntohs(s->v4.state);

        if (!(flags & IP_VS_CONN_F_TEMPLATE)) {
                pp = ip_vs_proto_get(s->v4.protocol);
                if (!pp) {
                        IP_VS_DBG(3,"BACKUP, Unsupported protocol %u\n",
                                s->v4.protocol);
                        retc = 30;
                        goto out;
                }
                if (state >= pp->num_states) {
                        IP_VS_DBG(3, "BACKUP, Invalid %s state %u\n",
                                pp->name, state);
                        retc = 40;
                        goto out;
                }
        } else {
                if (state >= IP_VS_CTPL_S_LAST)
                        IP_VS_DBG(7, "BACKUP, Invalid tpl state %u\n",
                                  state);
        }
        if (ip_vs_conn_fill_param_sync(ipvs, af, s, &param, pe_data,
                                       pe_data_len, pe_name, pe_name_len)) {
                retc = 50;
                goto out;
        }
        /* If only IPv4, just silent skip IPv6 */
        if (af == AF_INET)
                ip_vs_proc_conn(ipvs, &param, flags, state, s->v4.protocol, af,
                                (union nf_inet_addr *)&s->v4.daddr, s->v4.dport,
                                ntohl(s->v4.timeout), ntohl(s->v4.fwmark),
                                (opt_flags & IPVS_OPT_F_SEQ_DATA ? &opt : NULL)
                                );
#ifdef CONFIG_IP_VS_IPV6
        else
                ip_vs_proc_conn(ipvs, &param, flags, state, s->v6.protocol, af,
                                (union nf_inet_addr *)&s->v6.daddr, s->v6.dport,
                                ntohl(s->v6.timeout), ntohl(s->v6.fwmark),
                                (opt_flags & IPVS_OPT_F_SEQ_DATA ? &opt : NULL)
                                );
#endif
        ip_vs_pe_put(param.pe);
        return 0;
        /* Error exit */
out:
        IP_VS_DBG(2, "BACKUP, Single msg dropped err:%d\n", retc);
        return retc;

}
/*
 *      Process received multicast message and create the corresponding
 *      ip_vs_conn entries.
 *      Handles Version 0 & 1
 */
static void ip_vs_process_message(struct netns_ipvs *ipvs, __u8 *buffer,
                                  const size_t buflen)
{
        struct ip_vs_sync_mesg *m2 = (struct ip_vs_sync_mesg *)buffer;
        __u8 *p, *msg_end;
        int i, nr_conns;

        if (buflen < sizeof(struct ip_vs_sync_mesg_v0)) {
                IP_VS_DBG(2, "BACKUP, message header too short\n");
                return;
        }

        if (buflen != ntohs(m2->size)) {
                IP_VS_DBG(2, "BACKUP, bogus message size\n");
                return;
        }
        /* SyncID sanity check */
        if (ipvs->bcfg.syncid != 0 && m2->syncid != ipvs->bcfg.syncid) {
                IP_VS_DBG(7, "BACKUP, Ignoring syncid = %d\n", m2->syncid);
                return;
        }
        /* Handle version 1  message */
        if ((m2->version == SYNC_PROTO_VER) && (m2->reserved == 0)
            && (m2->spare == 0)) {

                msg_end = buffer + sizeof(struct ip_vs_sync_mesg);
                nr_conns = m2->nr_conns;

                for (i=0; i<nr_conns; i++) {
                        union ip_vs_sync_conn *s;
                        unsigned int size;
                        int retc;

                        p = msg_end;
                        if (p + sizeof(s->v4) > buffer+buflen) {
                                IP_VS_ERR_RL("BACKUP, Dropping buffer, too small\n");
                                return;
                        }
                        s = (union ip_vs_sync_conn *)p;
                        size = ntohs(s->v4.ver_size) & SVER_MASK;
                        msg_end = p + size;
                        /* Basic sanity checks */
                        if (msg_end  > buffer+buflen) {
                                IP_VS_ERR_RL("BACKUP, Dropping buffer, msg > buffer\n");
                                return;
                        }
                        if (ntohs(s->v4.ver_size) >> SVER_SHIFT) {
                                IP_VS_ERR_RL("BACKUP, Dropping buffer, Unknown version %d\n",
                                              ntohs(s->v4.ver_size) >> SVER_SHIFT);
                                return;
                        }
                        /* Process a single sync_conn */
                        retc = ip_vs_proc_sync_conn(ipvs, p, msg_end);
                        if (retc < 0) {
                                IP_VS_ERR_RL("BACKUP, Dropping buffer, Err: %d in decoding\n",
                                             retc);
                                return;
                        }
                        /* Make sure we have 32 bit alignment */
                        msg_end = p + ((size + 3) & ~3);
                }
        } else {
                /* Old type of message */
                ip_vs_process_message_v0(ipvs, buffer, buflen);
                return;
        }
}


/*
 *      Setup sndbuf (mode=1) or rcvbuf (mode=0)
 */
static void set_sock_size(struct sock *sk, int mode, int val)
{
        /* setsockopt(sock, SOL_SOCKET, SO_SNDBUF, &val, sizeof(val)); */
        /* setsockopt(sock, SOL_SOCKET, SO_RCVBUF, &val, sizeof(val)); */
        lock_sock(sk);
        if (mode) {
                val = clamp_t(int, val, (SOCK_MIN_SNDBUF + 1) / 2,
                              READ_ONCE(sysctl_wmem_max));
                sk->sk_sndbuf = val * 2;
                sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
        } else {
                val = clamp_t(int, val, (SOCK_MIN_RCVBUF + 1) / 2,
                              READ_ONCE(sysctl_rmem_max));
                sk->sk_rcvbuf = val * 2;
                sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
        }
        release_sock(sk);
}

/*
 *      Setup loopback of outgoing multicasts on a sending socket
 */
static void set_mcast_loop(struct sock *sk, u_char loop)
{
        /* setsockopt(sock, SOL_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)); */
        inet_assign_bit(MC_LOOP, sk, loop);
#ifdef CONFIG_IP_VS_IPV6
        if (READ_ONCE(sk->sk_family) == AF_INET6) {
                /* IPV6_MULTICAST_LOOP */
                inet6_assign_bit(MC6_LOOP, sk, loop);
        }
#endif
}

/*
 *      Specify TTL for outgoing multicasts on a sending socket
 */
static void set_mcast_ttl(struct sock *sk, u_char ttl)
{
        struct inet_sock *inet = inet_sk(sk);

        /* setsockopt(sock, SOL_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl)); */
        lock_sock(sk);
        WRITE_ONCE(inet->mc_ttl, ttl);
#ifdef CONFIG_IP_VS_IPV6
        if (sk->sk_family == AF_INET6) {
                struct ipv6_pinfo *np = inet6_sk(sk);

                /* IPV6_MULTICAST_HOPS */
                WRITE_ONCE(np->mcast_hops, ttl);
        }
#endif
        release_sock(sk);
}

/* Control fragmentation of messages */
static void set_mcast_pmtudisc(struct sock *sk, int val)
{
        struct inet_sock *inet = inet_sk(sk);

        /* setsockopt(sock, SOL_IP, IP_MTU_DISCOVER, &val, sizeof(val)); */
        lock_sock(sk);
        WRITE_ONCE(inet->pmtudisc, val);
#ifdef CONFIG_IP_VS_IPV6
        if (sk->sk_family == AF_INET6) {
                struct ipv6_pinfo *np = inet6_sk(sk);

                /* IPV6_MTU_DISCOVER */
                WRITE_ONCE(np->pmtudisc, val);
        }
#endif
        release_sock(sk);
}

/*
 *      Specifiy default interface for outgoing multicasts
 */
static int set_mcast_if(struct sock *sk, struct net_device *dev)
{
        struct inet_sock *inet = inet_sk(sk);

        if (sk->sk_bound_dev_if && dev->ifindex != sk->sk_bound_dev_if)
                return -EINVAL;

        lock_sock(sk);
        inet->mc_index = dev->ifindex;
        /*  inet->mc_addr  = 0; */
#ifdef CONFIG_IP_VS_IPV6
        if (sk->sk_family == AF_INET6) {
                struct ipv6_pinfo *np = inet6_sk(sk);

                /* IPV6_MULTICAST_IF */
                WRITE_ONCE(np->mcast_oif, dev->ifindex);
        }
#endif
        release_sock(sk);

        return 0;
}


/*
 *      Join a multicast group.
 *      the group is specified by a class D multicast address 224.0.0.0/8
 *      in the in_addr structure passed in as a parameter.
 */
static int
join_mcast_group(struct sock *sk, struct in_addr *addr, struct net_device *dev)
{
        struct ip_mreqn mreq;
        int ret;

        memset(&mreq, 0, sizeof(mreq));
        memcpy(&mreq.imr_multiaddr, addr, sizeof(struct in_addr));

        if (sk->sk_bound_dev_if && dev->ifindex != sk->sk_bound_dev_if)
                return -EINVAL;

        mreq.imr_ifindex = dev->ifindex;

        lock_sock(sk);
        ret = ip_mc_join_group(sk, &mreq);
        release_sock(sk);

        return ret;
}

#ifdef CONFIG_IP_VS_IPV6
static int join_mcast_group6(struct sock *sk, struct in6_addr *addr,
                             struct net_device *dev)
{
        int ret;

        if (sk->sk_bound_dev_if && dev->ifindex != sk->sk_bound_dev_if)
                return -EINVAL;

        lock_sock(sk);
        ret = ipv6_sock_mc_join(sk, dev->ifindex, addr);
        release_sock(sk);

        return ret;
}
#endif

static int bind_mcastif_addr(struct socket *sock, struct net_device *dev)
{
        __be32 addr;
        struct sockaddr_in sin;

        addr = inet_select_addr(dev, 0, RT_SCOPE_UNIVERSE);
        if (!addr)
                pr_err("You probably need to specify IP address on "
                       "multicast interface.\n");

        IP_VS_DBG(7, "binding socket with (%s) %pI4\n",
                  dev->name, &addr);

        /* Now bind the socket with the address of multicast interface */
        sin.sin_family             = AF_INET;
        sin.sin_addr.s_addr  = addr;
        sin.sin_port         = 0;

        return kernel_bind(sock, (struct sockaddr_unsized *)&sin, sizeof(sin));
}

static void get_mcast_sockaddr(union ipvs_sockaddr *sa, int *salen,
                               struct ipvs_sync_daemon_cfg *c, int id)
{
        if (AF_INET6 == c->mcast_af) {
                sa->in6 = (struct sockaddr_in6) {
                        .sin6_family = AF_INET6,
                        .sin6_port = htons(c->mcast_port + id),
                };
                sa->in6.sin6_addr = c->mcast_group.in6;
                *salen = sizeof(sa->in6);
        } else {
                sa->in = (struct sockaddr_in) {
                        .sin_family = AF_INET,
                        .sin_port = htons(c->mcast_port + id),
                };
                sa->in.sin_addr = c->mcast_group.in;
                *salen = sizeof(sa->in);
        }
}

/*
 *      Set up sending multicast socket over UDP
 */
static int make_send_sock(struct netns_ipvs *ipvs, int id,
                          struct net_device *dev, struct socket **sock_ret)
{
        /* multicast addr */
        union ipvs_sockaddr mcast_addr;
        struct socket *sock;
        int result, salen;

        /* First create a socket */
        result = sock_create_kern(ipvs->net, ipvs->mcfg.mcast_af, SOCK_DGRAM,
                                  IPPROTO_UDP, &sock);
        if (result < 0) {
                pr_err("Error during creation of socket; terminating\n");
                goto error;
        }
        *sock_ret = sock;
        result = set_mcast_if(sock->sk, dev);
        if (result < 0) {
                pr_err("Error setting outbound mcast interface\n");
                goto error;
        }

        set_mcast_loop(sock->sk, 0);
        set_mcast_ttl(sock->sk, ipvs->mcfg.mcast_ttl);
        /* Allow fragmentation if MTU changes */
        set_mcast_pmtudisc(sock->sk, IP_PMTUDISC_DONT);
        result = sysctl_sync_sock_size(ipvs);
        if (result > 0)
                set_sock_size(sock->sk, 1, result);

        if (AF_INET == ipvs->mcfg.mcast_af)
                result = bind_mcastif_addr(sock, dev);
        else
                result = 0;
        if (result < 0) {
                pr_err("Error binding address of the mcast interface\n");
                goto error;
        }

        get_mcast_sockaddr(&mcast_addr, &salen, &ipvs->mcfg, id);
        result = kernel_connect(sock, (struct sockaddr_unsized *)&mcast_addr,
                                salen, 0);
        if (result < 0) {
                pr_err("Error connecting to the multicast addr\n");
                goto error;
        }

        return 0;

error:
        return result;
}


/*
 *      Set up receiving multicast socket over UDP
 */
static int make_receive_sock(struct netns_ipvs *ipvs, int id,
                             struct net_device *dev, struct socket **sock_ret)
{
        /* multicast addr */
        union ipvs_sockaddr mcast_addr;
        struct socket *sock;
        int result, salen;

        /* First create a socket */
        result = sock_create_kern(ipvs->net, ipvs->bcfg.mcast_af, SOCK_DGRAM,
                                  IPPROTO_UDP, &sock);
        if (result < 0) {
                pr_err("Error during creation of socket; terminating\n");
                goto error;
        }
        *sock_ret = sock;
        /* it is equivalent to the REUSEADDR option in user-space */
        sock->sk->sk_reuse = SK_CAN_REUSE;
        result = sysctl_sync_sock_size(ipvs);
        if (result > 0)
                set_sock_size(sock->sk, 0, result);

        get_mcast_sockaddr(&mcast_addr, &salen, &ipvs->bcfg, id);
        sock->sk->sk_bound_dev_if = dev->ifindex;
        result = kernel_bind(sock, (struct sockaddr_unsized *)&mcast_addr, salen);
        if (result < 0) {
                pr_err("Error binding to the multicast addr\n");
                goto error;
        }

        /* join the multicast group */
#ifdef CONFIG_IP_VS_IPV6
        if (ipvs->bcfg.mcast_af == AF_INET6)
                result = join_mcast_group6(sock->sk, &mcast_addr.in6.sin6_addr,
                                           dev);
        else
#endif
                result = join_mcast_group(sock->sk, &mcast_addr.in.sin_addr,
                                          dev);
        if (result < 0) {
                pr_err("Error joining to the multicast group\n");
                goto error;
        }

        return 0;

error:
        return result;
}


static int
ip_vs_send_async(struct socket *sock, const char *buffer, const size_t length)
{
        struct msghdr        msg = {.msg_flags = MSG_DONTWAIT|MSG_NOSIGNAL};
        struct kvec        iov;
        int                len;

        iov.iov_base     = (void *)buffer;
        iov.iov_len      = length;

        len = kernel_sendmsg(sock, &msg, &iov, 1, (size_t)(length));

        return len;
}

static int
ip_vs_send_sync_msg(struct socket *sock, struct ip_vs_sync_mesg *msg)
{
        int msize;
        int ret;

        msize = ntohs(msg->size);

        ret = ip_vs_send_async(sock, (char *)msg, msize);
        if (ret >= 0 || ret == -EAGAIN)
                return ret;
        pr_err("ip_vs_send_async error %d\n", ret);
        return 0;
}

static int
ip_vs_receive(struct socket *sock, char *buffer, const size_t buflen)
{
        struct msghdr                msg = {NULL,};
        struct kvec                iov = {buffer, buflen};
        int                        len;

        /* Receive a packet */
        iov_iter_kvec(&msg.msg_iter, ITER_DEST, &iov, 1, buflen);
        len = sock_recvmsg(sock, &msg, MSG_DONTWAIT);
        if (len < 0)
                return len;

        return len;
}

/* Wakeup the master thread for sending */
static void master_wakeup_work_handler(struct work_struct *work)
{
        struct ipvs_master_sync_state *ms =
                container_of(work, struct ipvs_master_sync_state,
                             master_wakeup_work.work);
        struct netns_ipvs *ipvs = ms->ipvs;

        spin_lock_bh(&ipvs->sync_lock);
        if (ms->sync_queue_len &&
            ms->sync_queue_delay < IPVS_SYNC_WAKEUP_RATE) {
                int id = (int)(ms - ipvs->ms);

                ms->sync_queue_delay = IPVS_SYNC_WAKEUP_RATE;
                wake_up_process(ipvs->master_tinfo[id].task);
        }
        spin_unlock_bh(&ipvs->sync_lock);
}

/* Get next buffer to send */
static inline struct ip_vs_sync_buff *
next_sync_buff(struct netns_ipvs *ipvs, struct ipvs_master_sync_state *ms)
{
        struct ip_vs_sync_buff *sb;

        sb = sb_dequeue(ipvs, ms);
        if (sb)
                return sb;
        /* Do not delay entries in buffer for more than 2 seconds */
        return get_curr_sync_buff(ipvs, ms, IPVS_SYNC_FLUSH_TIME);
}

static int sync_thread_master(void *data)
{
        struct ip_vs_sync_thread_data *tinfo = data;
        struct netns_ipvs *ipvs = tinfo->ipvs;
        struct ipvs_master_sync_state *ms = &ipvs->ms[tinfo->id];
        struct sock *sk = tinfo->sock->sk;
        struct ip_vs_sync_buff *sb;

        pr_info("sync thread started: state = MASTER, mcast_ifn = %s, "
                "syncid = %d, id = %d\n",
                ipvs->mcfg.mcast_ifn, ipvs->mcfg.syncid, tinfo->id);

        for (;;) {
                sb = next_sync_buff(ipvs, ms);
                if (unlikely(kthread_should_stop()))
                        break;
                if (!sb) {
                        schedule_timeout(IPVS_SYNC_CHECK_PERIOD);
                        continue;
                }
                while (ip_vs_send_sync_msg(tinfo->sock, sb->mesg) < 0) {
                        /* (Ab)use interruptible sleep to avoid increasing
                         * the load avg.
                         */
                        __wait_event_interruptible(*sk_sleep(sk),
                                                   sock_writeable(sk) ||
                                                   kthread_should_stop());
                        if (unlikely(kthread_should_stop()))
                                goto done;
                }
                ip_vs_sync_buff_release(sb);
        }

done:
        __set_current_state(TASK_RUNNING);
        if (sb)
                ip_vs_sync_buff_release(sb);

        /* clean up the sync_buff queue */
        while ((sb = sb_dequeue(ipvs, ms)))
                ip_vs_sync_buff_release(sb);
        __set_current_state(TASK_RUNNING);

        /* clean up the current sync_buff */
        sb = get_curr_sync_buff(ipvs, ms, 0);
        if (sb)
                ip_vs_sync_buff_release(sb);

        return 0;
}


static int sync_thread_backup(void *data)
{
        struct ip_vs_sync_thread_data *tinfo = data;
        struct netns_ipvs *ipvs = tinfo->ipvs;
        struct sock *sk = tinfo->sock->sk;
        struct udp_sock *up = udp_sk(sk);
        int len;

        pr_info("sync thread started: state = BACKUP, mcast_ifn = %s, "
                "syncid = %d, id = %d\n",
                ipvs->bcfg.mcast_ifn, ipvs->bcfg.syncid, tinfo->id);

        while (!kthread_should_stop()) {
                wait_event_interruptible(*sk_sleep(sk),
                                         !skb_queue_empty_lockless(&sk->sk_receive_queue) ||
                                         !skb_queue_empty_lockless(&up->reader_queue) ||
                                         kthread_should_stop());

                /* do we have data now? */
                while (!skb_queue_empty_lockless(&sk->sk_receive_queue) ||
                       !skb_queue_empty_lockless(&up->reader_queue)) {
                        len = ip_vs_receive(tinfo->sock, tinfo->buf,
                                        ipvs->bcfg.sync_maxlen);
                        if (len <= 0) {
                                if (len != -EAGAIN)
                                        pr_err("receiving message error\n");
                                break;
                        }

                        ip_vs_process_message(ipvs, tinfo->buf, len);
                }
        }

        return 0;
}


int start_sync_thread(struct netns_ipvs *ipvs, struct ipvs_sync_daemon_cfg *c,
                      int state)
{
        struct ip_vs_sync_thread_data *ti = NULL, *tinfo;
        struct task_struct *task;
        struct net_device *dev;
        char *name;
        int (*threadfn)(void *data);
        int id = 0, count, hlen;
        int result = -ENOMEM;
        u16 mtu, min_mtu;

        IP_VS_DBG(7, "%s(): pid %d\n", __func__, task_pid_nr(current));
        IP_VS_DBG(7, "Each ip_vs_sync_conn entry needs %zd bytes\n",
                  sizeof(struct ip_vs_sync_conn_v0));

        /* increase the module use count */
        if (!ip_vs_use_count_inc())
                return -ENOPROTOOPT;

        /* Backup server can be started without services just to sync conns,
         * make sure conn_tab is created even if ipvs->enable is 0.
         */
        if (state == IP_VS_STATE_BACKUP) {
                mutex_lock(&ipvs->service_mutex);
                if (!rcu_dereference_protected(ipvs->conn_tab, 1)) {
                        int lfactor = sysctl_conn_lfactor(ipvs);
                        int new_size = ip_vs_conn_desired_size(ipvs, NULL,
                                                               lfactor);
                        struct ip_vs_rht *tc_new;

                        tc_new = ip_vs_conn_tab_alloc(ipvs, new_size, lfactor);
                        if (!tc_new) {
                                mutex_unlock(&ipvs->service_mutex);
                                result = -ENOMEM;
                                goto out_module;
                        }
                        rcu_assign_pointer(ipvs->conn_tab, tc_new);
                }
                mutex_unlock(&ipvs->service_mutex);
        }

        /* Do not hold one mutex and then to block on another */
        for (;;) {
                rtnl_lock();
                if (mutex_trylock(&ipvs->sync_mutex))
                        break;
                rtnl_unlock();
                mutex_lock(&ipvs->sync_mutex);
                if (rtnl_trylock())
                        break;
                mutex_unlock(&ipvs->sync_mutex);
        }

        if (!ipvs->sync_state) {
                count = clamp(sysctl_sync_ports(ipvs), 1, IPVS_SYNC_PORTS_MAX);
                ipvs->threads_mask = count - 1;
        } else
                count = ipvs->threads_mask + 1;

        if (c->mcast_af == AF_UNSPEC) {
                c->mcast_af = AF_INET;
                c->mcast_group.ip = cpu_to_be32(IP_VS_SYNC_GROUP);
        }
        if (!c->mcast_port)
                c->mcast_port = IP_VS_SYNC_PORT;
        if (!c->mcast_ttl)
                c->mcast_ttl = 1;

        dev = __dev_get_by_name(ipvs->net, c->mcast_ifn);
        if (!dev) {
                pr_err("Unknown mcast interface: %s\n", c->mcast_ifn);
                result = -ENODEV;
                goto out_early;
        }
        hlen = (AF_INET6 == c->mcast_af) ?
               sizeof(struct ipv6hdr) + sizeof(struct udphdr) :
               sizeof(struct iphdr) + sizeof(struct udphdr);
        mtu = (state == IP_VS_STATE_BACKUP) ?
                  clamp(dev->mtu, 1500U, 65535U) : 1500U;
        min_mtu = (state == IP_VS_STATE_BACKUP) ? 1024 : 1;

        if (c->sync_maxlen)
                c->sync_maxlen = clamp_t(unsigned int,
                                         c->sync_maxlen, min_mtu,
                                         65535 - hlen);
        else
                c->sync_maxlen = mtu - hlen;

        if (state == IP_VS_STATE_MASTER) {
                result = -EEXIST;
                if (ipvs->ms)
                        goto out_early;

                ipvs->mcfg = *c;
                name = "ipvs-m:%d:%d";
                threadfn = sync_thread_master;
        } else if (state == IP_VS_STATE_BACKUP) {
                result = -EEXIST;
                if (ipvs->backup_tinfo)
                        goto out_early;

                ipvs->bcfg = *c;
                name = "ipvs-b:%d:%d";
                threadfn = sync_thread_backup;
        } else {
                result = -EINVAL;
                goto out_early;
        }

        if (state == IP_VS_STATE_MASTER) {
                struct ipvs_master_sync_state *ms;

                result = -ENOMEM;
                ipvs->ms = kzalloc_objs(ipvs->ms[0], count);
                if (!ipvs->ms)
                        goto out;
                ms = ipvs->ms;
                for (id = 0; id < count; id++, ms++) {
                        INIT_LIST_HEAD(&ms->sync_queue);
                        ms->sync_queue_len = 0;
                        ms->sync_queue_delay = 0;
                        INIT_DELAYED_WORK(&ms->master_wakeup_work,
                                          master_wakeup_work_handler);
                        ms->ipvs = ipvs;
                }
        }
        result = -ENOMEM;
        ti = kzalloc_objs(struct ip_vs_sync_thread_data, count);
        if (!ti)
                goto out;

        for (id = 0; id < count; id++) {
                tinfo = &ti[id];
                tinfo->ipvs = ipvs;
                if (state == IP_VS_STATE_BACKUP) {
                        result = -ENOMEM;
                        tinfo->buf = kmalloc(ipvs->bcfg.sync_maxlen,
                                             GFP_KERNEL);
                        if (!tinfo->buf)
                                goto out;
                }
                tinfo->id = id;
                if (state == IP_VS_STATE_MASTER)
                        result = make_send_sock(ipvs, id, dev, &tinfo->sock);
                else
                        result = make_receive_sock(ipvs, id, dev, &tinfo->sock);
                if (result < 0)
                        goto out;

                task = kthread_run(threadfn, tinfo, name, ipvs->gen, id);
                if (IS_ERR(task)) {
                        result = PTR_ERR(task);
                        goto out;
                }
                tinfo->task = task;
        }

        /* mark as active */

        if (state == IP_VS_STATE_MASTER)
                ipvs->master_tinfo = ti;
        else
                ipvs->backup_tinfo = ti;
        spin_lock_bh(&ipvs->sync_buff_lock);
        ipvs->sync_state |= state;
        spin_unlock_bh(&ipvs->sync_buff_lock);

        mutex_unlock(&ipvs->sync_mutex);
        rtnl_unlock();

        return 0;

out:
        /* We do not need RTNL lock anymore, release it here so that
         * sock_release below can use rtnl_lock to leave the mcast group.
         */
        rtnl_unlock();
        id = min(id, count - 1);
        if (ti) {
                for (tinfo = ti + id; tinfo >= ti; tinfo--) {
                        if (tinfo->task)
                                kthread_stop(tinfo->task);
                }
        }
        if (!(ipvs->sync_state & IP_VS_STATE_MASTER)) {
                kfree(ipvs->ms);
                ipvs->ms = NULL;
        }
        mutex_unlock(&ipvs->sync_mutex);

        /* No more mutexes, release socks */
        if (ti) {
                for (tinfo = ti + id; tinfo >= ti; tinfo--) {
                        if (tinfo->sock)
                                sock_release(tinfo->sock);
                        kfree(tinfo->buf);
                }
                kfree(ti);
        }

        /* decrease the module use count */
        ip_vs_use_count_dec();
        return result;

out_early:
        mutex_unlock(&ipvs->sync_mutex);
        rtnl_unlock();

out_module:
        /* decrease the module use count */
        ip_vs_use_count_dec();
        return result;
}


int stop_sync_thread(struct netns_ipvs *ipvs, int state)
{
        struct ip_vs_sync_thread_data *ti, *tinfo;
        int id;
        int retc = -EINVAL;

        IP_VS_DBG(7, "%s(): pid %d\n", __func__, task_pid_nr(current));

        mutex_lock(&ipvs->sync_mutex);
        if (state == IP_VS_STATE_MASTER) {
                retc = -ESRCH;
                if (!ipvs->ms)
                        goto err;
                ti = ipvs->master_tinfo;

                /*
                 * The lock synchronizes with sb_queue_tail(), so that we don't
                 * add sync buffers to the queue, when we are already in
                 * progress of stopping the master sync daemon.
                 */

                spin_lock_bh(&ipvs->sync_buff_lock);
                spin_lock(&ipvs->sync_lock);
                ipvs->sync_state &= ~IP_VS_STATE_MASTER;
                spin_unlock(&ipvs->sync_lock);
                spin_unlock_bh(&ipvs->sync_buff_lock);

                retc = 0;
                for (id = ipvs->threads_mask; id >= 0; id--) {
                        struct ipvs_master_sync_state *ms = &ipvs->ms[id];
                        int ret;

                        tinfo = &ti[id];
                        pr_info("stopping master sync thread %d ...\n",
                                task_pid_nr(tinfo->task));
                        cancel_delayed_work_sync(&ms->master_wakeup_work);
                        ret = kthread_stop(tinfo->task);
                        if (retc >= 0)
                                retc = ret;
                }
                kfree(ipvs->ms);
                ipvs->ms = NULL;
                ipvs->master_tinfo = NULL;
        } else if (state == IP_VS_STATE_BACKUP) {
                retc = -ESRCH;
                if (!ipvs->backup_tinfo)
                        goto err;
                ti = ipvs->backup_tinfo;

                ipvs->sync_state &= ~IP_VS_STATE_BACKUP;
                retc = 0;
                for (id = ipvs->threads_mask; id >= 0; id--) {
                        int ret;

                        tinfo = &ti[id];
                        pr_info("stopping backup sync thread %d ...\n",
                                task_pid_nr(tinfo->task));
                        ret = kthread_stop(tinfo->task);
                        if (retc >= 0)
                                retc = ret;
                }
                ipvs->backup_tinfo = NULL;
        } else {
                goto err;
        }
        id = ipvs->threads_mask;
        mutex_unlock(&ipvs->sync_mutex);

        /* No more mutexes, release socks */
        for (tinfo = ti + id; tinfo >= ti; tinfo--) {
                if (tinfo->sock)
                        sock_release(tinfo->sock);
                kfree(tinfo->buf);
        }
        kfree(ti);

        /* decrease the module use count */
        ip_vs_use_count_dec();
        return retc;

err:
        mutex_unlock(&ipvs->sync_mutex);
        return retc;
}

/*
 * Initialize data struct for each netns
 */
int __net_init ip_vs_sync_net_init(struct netns_ipvs *ipvs)
{
        __mutex_init(&ipvs->sync_mutex, "ipvs->sync_mutex", &__ipvs_sync_key);
        spin_lock_init(&ipvs->sync_lock);
        spin_lock_init(&ipvs->sync_buff_lock);
        return 0;
}

void ip_vs_sync_net_cleanup(struct netns_ipvs *ipvs)
{
        int retc;

        retc = stop_sync_thread(ipvs, IP_VS_STATE_MASTER);
        if (retc && retc != -ESRCH)
                pr_err("Failed to stop Master Daemon\n");

        retc = stop_sync_thread(ipvs, IP_VS_STATE_BACKUP);
        if (retc && retc != -ESRCH)
                pr_err("Failed to stop Backup Daemon\n");
}


















































































































   26 
   25 
    2 
   26 





    3 

    3 
    3 
    3 
    3 






    3 
    3 













   15 



   15 

   15 

   16 












   16 



   15 
   15 
   16 
























































































































    1 










    1 


    1 












    1 





    1 



































    6 





    2 

    7 

    2 




    9 

   15 













    1 


    1 
    1 














    3 

    2 


    1 
































    3 


    3 



    1 




    1 


    3 






    3 















































































































































































































































































































    7 







    4 




    4 































    4 












    4 

    4 
























    4 












    4 



    4 









    6 
















    4 






    4 








    4 






























































































































































    4 














    4 



    4 





    4 






    4 







































    4 
    4 



    4 




























    9 





    9 
    9 











    9 
    4 









    4 













    4 
    4 









    4 






    4 









    4 


    1 



    3 


    8 
    6 

    6 












    6 






    9 
    7 

    9 








    9 


















    8 

    8 









    4 










    3 


    3 


    3 


    3 



    3 








    6 
    4 
    6 


    4 



    1 




    1 


    1 



















    2 
    1 
    2 








   13 



   13 

   13 
    7 


    7 


    7 

    7 

    6 


    7 

    7 
    4 

   13 








   16 


   14 




   13 






    2 

    6 






    2 










    4 







    4 























    4 







    5 






    4 




    4 
    4 
    4 



    4 
    4 











    5 













    6 









   21 





   29 








   28 


   27 




   26 
    1 


   25 






   25 





   25 

   25 




   24 





    8 






    8 





    7 






    6 

    1 



    2 

    4 








    2 








    2 


    1 






    1 


    2 



    1 






    1 
    1 










    2 

    1 
   17 




   16 







   16 

    3 






   14 











   12 

    1 




   11 




   14 


   25 

   25 

   29 












   53 






   52 




    9 



    8 


    8 




    8 
    8 


    3 





   35 
   36 




   35 













   35 


   34 
   34 
    1 
   50 


   34 

   12 




   19 








   16 



   15 


   15 

    1 



   14 

   14 
   18 




    1 





















    2 




















   12 






   11 



   12 


    5 





    3 






    4 



    2 
    1 
    2 



    4 
    4 


    4 








    3 






    2 






    1 



















    1 








    2 

    5 

    5 



    2 

    5 


    1 


    1 




    1 













    8 


    5 





    8 
    1 
    7 
    2 




    2 
    1 
    3 
    2 
    1 


    7 



    6 



    8 





  323 



 1431 


    5 


    5 

    2 

    2 

    2 




    5 

  323 


 1434 













































    8 

    7 


    6 


    5 





    5 


















    5 
    5 



    8 














   51 






    1 
    1 

















































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
// SPDX-License-Identifier: GPL-2.0
/* XDP sockets
 *
 * AF_XDP sockets allows a channel between XDP programs and userspace
 * applications.
 * Copyright(c) 2018 Intel Corporation.
 *
 * Author(s): Björn Töpel <bjorn.topel@intel.com>
 *              Magnus Karlsson <magnus.karlsson@intel.com>
 */

#define pr_fmt(fmt) "AF_XDP: %s: " fmt, __func__

#include <linux/if_xdp.h>
#include <linux/init.h>
#include <linux/sched/mm.h>
#include <linux/sched/signal.h>
#include <linux/sched/task.h>
#include <linux/socket.h>
#include <linux/file.h>
#include <linux/uaccess.h>
#include <linux/net.h>
#include <linux/netdevice.h>
#include <linux/rculist.h>
#include <linux/uio.h>
#include <linux/vmalloc.h>

#include <net/netdev_queues.h>
#include <net/xdp_sock_drv.h>
#include <net/busy_poll.h>
#include <net/netdev_lock.h>
#include <net/netdev_rx_queue.h>
#include <net/xdp.h>

#include "../core/dev.h"

#include "xsk_queue.h"
#include "xdp_umem.h"
#include "xsk.h"

#define TX_BATCH_SIZE 32
#define MAX_PER_SOCKET_BUDGET 32

struct xsk_addrs {
        u32 num_descs;
        u64 addrs[MAX_SKB_FRAGS + 1];
};

static struct kmem_cache *xsk_tx_generic_cache;

void xsk_set_rx_need_wakeup(struct xsk_buff_pool *pool)
{
        if (pool->cached_need_wakeup & XDP_WAKEUP_RX)
                return;

        pool->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
        pool->cached_need_wakeup |= XDP_WAKEUP_RX;
}
EXPORT_SYMBOL(xsk_set_rx_need_wakeup);

void xsk_set_tx_need_wakeup(struct xsk_buff_pool *pool)
{
        struct xdp_sock *xs;

        if (pool->cached_need_wakeup & XDP_WAKEUP_TX)
                return;

        rcu_read_lock();
        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
                xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
        }
        rcu_read_unlock();

        pool->cached_need_wakeup |= XDP_WAKEUP_TX;
}
EXPORT_SYMBOL(xsk_set_tx_need_wakeup);

void xsk_clear_rx_need_wakeup(struct xsk_buff_pool *pool)
{
        if (!(pool->cached_need_wakeup & XDP_WAKEUP_RX))
                return;

        pool->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
        pool->cached_need_wakeup &= ~XDP_WAKEUP_RX;
}
EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);

void xsk_clear_tx_need_wakeup(struct xsk_buff_pool *pool)
{
        struct xdp_sock *xs;

        if (!(pool->cached_need_wakeup & XDP_WAKEUP_TX))
                return;

        rcu_read_lock();
        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
                xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
        }
        rcu_read_unlock();

        pool->cached_need_wakeup &= ~XDP_WAKEUP_TX;
}
EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);

bool xsk_uses_need_wakeup(struct xsk_buff_pool *pool)
{
        return pool->uses_need_wakeup;
}
EXPORT_SYMBOL(xsk_uses_need_wakeup);

struct xsk_buff_pool *xsk_get_pool_from_qid(struct net_device *dev,
                                            u16 queue_id)
{
        if (queue_id < dev->real_num_rx_queues)
                return dev->_rx[queue_id].pool;
        if (queue_id < dev->real_num_tx_queues)
                return dev->_tx[queue_id].pool;

        return NULL;
}
EXPORT_SYMBOL(xsk_get_pool_from_qid);

static void __xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
{
        if (queue_id < dev->num_rx_queues)
                dev->_rx[queue_id].pool = NULL;
        if (queue_id < dev->num_tx_queues)
                dev->_tx[queue_id].pool = NULL;
}

void xsk_clear_pool_at_qid(struct net_device *dev, u16 queue_id)
{
        struct netdev_rx_queue *hw_rxq;

        if (!netif_rxq_is_leased(dev, queue_id))
                return __xsk_clear_pool_at_qid(dev, queue_id);
        WARN_ON_ONCE(!netif_is_queue_leasee(dev));

        hw_rxq = __netif_get_rx_queue(dev, queue_id)->lease;

        netdev_lock(hw_rxq->dev);
        queue_id = get_netdev_rx_queue_index(hw_rxq);
        __xsk_clear_pool_at_qid(hw_rxq->dev, queue_id);
        netdev_unlock(hw_rxq->dev);
}

static int __xsk_reg_pool_at_qid(struct net_device *dev,
                                 struct xsk_buff_pool *pool, u16 queue_id)
{
        if (xsk_get_pool_from_qid(dev, queue_id))
                return -EBUSY;

        if (queue_id < dev->real_num_rx_queues)
                dev->_rx[queue_id].pool = pool;
        if (queue_id < dev->real_num_tx_queues)
                dev->_tx[queue_id].pool = pool;

        return 0;
}

/* The buffer pool is stored both in the _rx struct and the _tx struct as we do
 * not know if the device has more tx queues than rx, or the opposite.
 * This might also change during run time.
 */
int xsk_reg_pool_at_qid(struct net_device *dev, struct xsk_buff_pool *pool,
                        u16 queue_id)
{
        struct netdev_rx_queue *hw_rxq;
        int ret;

        if (queue_id >= max(dev->real_num_rx_queues,
                            dev->real_num_tx_queues))
                return -EINVAL;

        if (queue_id >= dev->real_num_rx_queues ||
            !netif_rxq_is_leased(dev, queue_id))
                return __xsk_reg_pool_at_qid(dev, pool, queue_id);
        if (!netif_is_queue_leasee(dev))
                return -EBUSY;

        hw_rxq = __netif_get_rx_queue(dev, queue_id)->lease;

        netdev_lock(hw_rxq->dev);
        queue_id = get_netdev_rx_queue_index(hw_rxq);
        ret = __xsk_reg_pool_at_qid(hw_rxq->dev, pool, queue_id);
        netdev_unlock(hw_rxq->dev);

        return ret;
}

static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff_xsk *xskb, u32 len,
                        u32 flags)
{
        u64 addr;
        int err;

        addr = xp_get_handle(xskb, xskb->pool);
        err = xskq_prod_reserve_desc(xs->rx, addr, len, flags);
        if (err) {
                xs->rx_queue_full++;
                return err;
        }

        xp_release(xskb);
        return 0;
}

static void __xsk_rcv_zc_safe(struct xdp_sock *xs, struct xdp_buff_xsk *xskb,
                              u32 len, u32 flags)
{
        u64 addr;

        addr = xp_get_handle(xskb, xskb->pool);
        __xskq_prod_reserve_desc(xs->rx, addr, len, flags);

        xp_release(xskb);
}

static int xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
{
        struct xdp_buff_xsk *xskb = container_of(xdp, struct xdp_buff_xsk, xdp);
        u32 frags = xdp_buff_has_frags(xdp);
        struct xdp_buff_xsk *pos, *tmp;
        struct list_head *xskb_list;
        u32 contd = 0;
        u32 num_desc;
        int err;

        if (likely(!frags)) {
                err = __xsk_rcv_zc(xs, xskb, len, contd);
                if (err)
                        goto err;
                return 0;
        }

        contd = XDP_PKT_CONTD;
        num_desc = xdp_get_shared_info_from_buff(xdp)->nr_frags + 1;
        if (xskq_prod_nb_free(xs->rx, num_desc) < num_desc) {
                xs->rx_queue_full++;
                err = -ENOBUFS;
                goto err;
        }

        __xsk_rcv_zc_safe(xs, xskb, len, contd);
        xskb_list = &xskb->pool->xskb_list;
        list_for_each_entry_safe(pos, tmp, xskb_list, list_node) {
                if (list_is_singular(xskb_list))
                        contd = 0;
                len = pos->xdp.data_end - pos->xdp.data;
                __xsk_rcv_zc_safe(xs, pos, len, contd);
                list_del_init(&pos->list_node);
        }

        return 0;
err:
        xsk_buff_free(xdp);
        return err;
}

static void *xsk_copy_xdp_start(struct xdp_buff *from)
{
        if (unlikely(xdp_data_meta_unsupported(from)))
                return from->data;
        else
                return from->data_meta;
}

static u32 xsk_copy_xdp(void *to, void **from, u32 to_len,
                        u32 *from_len, skb_frag_t **frag, u32 rem)
{
        u32 copied = 0;

        while (1) {
                u32 copy_len = min_t(u32, *from_len, to_len);

                memcpy(to, *from, copy_len);
                copied += copy_len;
                if (rem == copied)
                        return copied;

                if (*from_len == copy_len) {
                        *from = skb_frag_address(*frag);
                        *from_len = skb_frag_size((*frag)++);
                } else {
                        *from += copy_len;
                        *from_len -= copy_len;
                }
                if (to_len == copy_len)
                        return copied;

                to_len -= copy_len;
                to += copy_len;
        }
}

static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
{
        u32 frame_size = __xsk_pool_get_rx_frame_size(xs->pool);
        void *copy_from = xsk_copy_xdp_start(xdp), *copy_to;
        u32 from_len, meta_len, rem, num_desc;
        struct xdp_buff_xsk *xskb;
        struct xdp_buff *xsk_xdp;
        skb_frag_t *frag;

        from_len = xdp->data_end - copy_from;
        meta_len = xdp->data - copy_from;
        rem = len + meta_len;

        if (len <= frame_size && !xdp_buff_has_frags(xdp)) {
                int err;

                xsk_xdp = xsk_buff_alloc(xs->pool);
                if (!xsk_xdp) {
                        xs->rx_dropped++;
                        return -ENOMEM;
                }
                memcpy(xsk_xdp->data - meta_len, copy_from, rem);
                xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
                err = __xsk_rcv_zc(xs, xskb, len, 0);
                if (err) {
                        xsk_buff_free(xsk_xdp);
                        return err;
                }

                return 0;
        }

        num_desc = (len - 1) / frame_size + 1;

        if (!xsk_buff_can_alloc(xs->pool, num_desc)) {
                xs->rx_dropped++;
                return -ENOMEM;
        }
        if (xskq_prod_nb_free(xs->rx, num_desc) < num_desc) {
                xs->rx_queue_full++;
                return -ENOBUFS;
        }

        if (xdp_buff_has_frags(xdp)) {
                struct skb_shared_info *sinfo;

                sinfo = xdp_get_shared_info_from_buff(xdp);
                frag =  &sinfo->frags[0];
        }

        do {
                u32 to_len = frame_size + meta_len;
                u32 copied;

                xsk_xdp = xsk_buff_alloc(xs->pool);
                copy_to = xsk_xdp->data - meta_len;

                copied = xsk_copy_xdp(copy_to, &copy_from, to_len, &from_len, &frag, rem);
                rem -= copied;

                xskb = container_of(xsk_xdp, struct xdp_buff_xsk, xdp);
                __xsk_rcv_zc_safe(xs, xskb, copied - meta_len,
                                  rem ? XDP_PKT_CONTD : 0);
                meta_len = 0;
        } while (rem);

        return 0;
}

static bool xsk_tx_writeable(struct xdp_sock *xs)
{
        if (xskq_cons_present_entries(xs->tx) > xs->tx->nentries / 2)
                return false;

        return true;
}

static void __xsk_tx_release(struct xdp_sock *xs)
{
        __xskq_cons_release(xs->tx);
        if (xsk_tx_writeable(xs))
                xs->sk.sk_write_space(&xs->sk);
}

static bool xsk_is_bound(struct xdp_sock *xs)
{
        if (READ_ONCE(xs->state) == XSK_BOUND) {
                /* Matches smp_wmb() in bind(). */
                smp_rmb();
                return true;
        }
        return false;
}

static bool xsk_dev_queue_valid(const struct xdp_sock *xs,
                                const struct xdp_rxq_info *info)
{
        struct net_device *dev = xs->dev;
        u32 queue_index = xs->queue_id;
        struct netdev_rx_queue *rxq;

        if (info->dev == dev &&
            info->queue_index == queue_index)
                return true;

        if (queue_index < dev->real_num_rx_queues) {
                rxq = READ_ONCE(__netif_get_rx_queue(dev, queue_index)->lease);
                if (!rxq)
                        return false;

                dev = rxq->dev;
                queue_index = get_netdev_rx_queue_index(rxq);

                return info->dev == dev &&
                       info->queue_index == queue_index;
        }
        return false;
}

static int xsk_rcv_check(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
{
        if (!xsk_is_bound(xs))
                return -ENXIO;
        if (!xsk_dev_queue_valid(xs, xdp->rxq))
                return -EINVAL;

        if (len > __xsk_pool_get_rx_frame_size(xs->pool) && !xs->sg) {
                xs->rx_dropped++;
                return -ENOSPC;
        }

        return 0;
}

static void xsk_flush(struct xdp_sock *xs)
{
        xskq_prod_submit(xs->rx);
        __xskq_cons_release(xs->pool->fq);
        sock_def_readable(&xs->sk);
}

int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
{
        u32 len = xdp_get_buff_len(xdp);
        int err;

        err = xsk_rcv_check(xs, xdp, len);
        if (!err) {
                spin_lock_bh(&xs->pool->rx_lock);
                err = __xsk_rcv(xs, xdp, len);
                xsk_flush(xs);
                spin_unlock_bh(&xs->pool->rx_lock);
        }

        return err;
}

static int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
{
        u32 len = xdp_get_buff_len(xdp);
        int err;

        err = xsk_rcv_check(xs, xdp, len);
        if (err)
                return err;

        if (xdp->rxq->mem.type == MEM_TYPE_XSK_BUFF_POOL) {
                len = xdp->data_end - xdp->data;
                return xsk_rcv_zc(xs, xdp, len);
        }

        err = __xsk_rcv(xs, xdp, len);
        if (!err)
                xdp_return_buff(xdp);
        return err;
}

int __xsk_map_redirect(struct xdp_sock *xs, struct xdp_buff *xdp)
{
        int err;

        err = xsk_rcv(xs, xdp);
        if (err)
                return err;

        if (!xs->flush_node.prev) {
                struct list_head *flush_list = bpf_net_ctx_get_xskmap_flush_list();

                list_add(&xs->flush_node, flush_list);
        }

        return 0;
}

void __xsk_map_flush(struct list_head *flush_list)
{
        struct xdp_sock *xs, *tmp;

        list_for_each_entry_safe(xs, tmp, flush_list, flush_node) {
                xsk_flush(xs);
                __list_del_clearprev(&xs->flush_node);
        }
}

void xsk_tx_completed(struct xsk_buff_pool *pool, u32 nb_entries)
{
        u32 reclaim_descs = READ_ONCE(pool->reclaim_descs);

        if (unlikely(reclaim_descs)) {
                u32 pending_descs = READ_ONCE(pool->tx_zc_pending_descs);

                if (nb_entries < pending_descs) {
                        WRITE_ONCE(pool->tx_zc_pending_descs,
                                   pending_descs - nb_entries);
                        xskq_prod_submit_n(pool->cq, nb_entries);
                        return;
                }

                WRITE_ONCE(pool->tx_zc_pending_descs, 0);
                nb_entries += reclaim_descs;
                WRITE_ONCE(pool->reclaim_descs, 0);
        }

        xskq_prod_submit_n(pool->cq, nb_entries);
}
EXPORT_SYMBOL(xsk_tx_completed);

void xsk_tx_release(struct xsk_buff_pool *pool)
{
        struct xdp_sock *xs;

        rcu_read_lock();
        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
                __xsk_tx_release(xs);
        rcu_read_unlock();
}
EXPORT_SYMBOL(xsk_tx_release);

bool xsk_tx_peek_desc(struct xsk_buff_pool *pool, struct xdp_desc *desc)
{
        bool budget_exhausted = false;
        struct xdp_sock *xs;

        rcu_read_lock();
again:
        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
                if (xs->tx_budget_spent >= MAX_PER_SOCKET_BUDGET) {
                        budget_exhausted = true;
                        continue;
                }

                if (!xskq_cons_peek_desc(xs->tx, desc, pool)) {
                        if (xskq_has_descs(xs->tx))
                                xskq_cons_release(xs->tx);
                        continue;
                }

                xs->tx_budget_spent++;

                /* This is the backpressure mechanism for the Tx path.
                 * Reserve space in the completion queue and only proceed
                 * if there is space in it. This avoids having to implement
                 * any buffering in the Tx path.
                 */
                if (xskq_prod_reserve_addr(pool->cq, desc->addr))
                        goto out;

                xskq_cons_release(xs->tx);
                rcu_read_unlock();
                return true;
        }

        if (budget_exhausted) {
                list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
                        xs->tx_budget_spent = 0;

                budget_exhausted = false;
                goto again;
        }

out:
        rcu_read_unlock();
        return false;
}
EXPORT_SYMBOL(xsk_tx_peek_desc);

static u32 xsk_tx_peek_release_fallback(struct xsk_buff_pool *pool, u32 max_entries)
{
        struct xdp_desc *descs = pool->tx_descs;
        u32 nb_pkts = 0;

        while (nb_pkts < max_entries && xsk_tx_peek_desc(pool, &descs[nb_pkts]))
                nb_pkts++;

        xsk_tx_release(pool);
        return nb_pkts;
}

static void xsk_tx_commit_batch(struct xsk_buff_pool *pool,
                                struct xsk_tx_batch *batch)
{
        u32 nb_descs = xsk_tx_batch_cq_descs(batch);
        u32 cq_cached_prod;

        if (!nb_descs)
                return;

        cq_cached_prod = pool->cq->cached_prod;
        xskq_prod_write_addr_batch(pool->cq, pool->tx_descs, nb_descs);

        if (unlikely(batch->reclaim_descs)) {
                u32 cq_pending_descs;

                /* CQ is positional. Descriptors already written but not
                 * submitted must complete before any reclaim-only descriptors
                 * appended below.
                 */
                cq_pending_descs = cq_cached_prod - xskq_get_prod(pool->cq);

                WRITE_ONCE(pool->tx_zc_pending_descs,
                           batch->tx_descs + cq_pending_descs);
                WRITE_ONCE(pool->reclaim_descs, batch->reclaim_descs);
                if (unlikely(!pool->tx_zc_pending_descs))
                        xsk_tx_completed(pool, 0);
        }
}

static struct xsk_tx_batch
__xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, struct xdp_sock *xs,
                                 struct xdp_desc *descs, u32 max_descs)
{
        struct xsk_tx_batch batch = {};
        u32 entries;

        entries = xskq_cons_nb_entries(xs->tx, max_descs);
        if (!entries)
                return batch;

        batch = xskq_cons_read_desc_batch(xs, pool, descs, max_descs);
        if (!xsk_tx_batch_cq_descs(&batch)) {
                xs->tx->queue_empty_descs++;
        } else {
                __xskq_cons_release(xs->tx);
                xs->sk.sk_write_space(&xs->sk);
        }
        return batch;
}

static struct xsk_tx_batch
xsk_tx_peek_release_shared_desc_batch(struct xsk_buff_pool *pool, u32 max_descs)
{
        u32 cq_descs_before, cq_descs_after;
        struct xsk_tx_batch sum_batch = {};
        bool budget_exhausted;
        u32 per_socket_budget;
        struct xdp_sock *xs;

        /* The fairness quota must allow one maximum-sized valid packet. */
        per_socket_budget = max_t(u32, MAX_PER_SOCKET_BUDGET,
                                  pool->xdp_zc_max_segs);

again:
        budget_exhausted = false;
        cq_descs_before = xsk_tx_batch_cq_descs(&sum_batch);
        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list) {
                u32 budget, budget_left, offset, remaining, used;
                struct xsk_tx_batch curr_batch;

                /* Once reclaim-only descriptors have been appended to the CQ
                 * address area, do not append driver-visible Tx descriptors
                 * from another socket after them. xsk_tx_completed() relies on
                 * all driver-visible descriptors preceding all reclaim-only
                 * descriptors in CQ order.
                 */
                if (sum_batch.reclaim_descs)
                        break;

                /* be gentle when playing with pool->tx_descs */
                offset = xsk_tx_batch_cq_descs(&sum_batch);
                if (offset >= max_descs)
                        break;

                if (xs->tx_budget_spent >= per_socket_budget) {
                        if (xskq_cons_nb_entries(xs->tx, 1))
                                budget_exhausted = true;
                        continue;
                }

                budget_left = per_socket_budget - xs->tx_budget_spent;
                remaining = max_descs - offset;
                budget = min(remaining, budget_left);

                curr_batch = __xsk_tx_peek_release_desc_batch(pool, xs,
                                                              pool->tx_descs + offset,
                                                              budget);
                used = xsk_tx_batch_cq_descs(&curr_batch);
                if (!used) {
                        if (curr_batch.budget_limited && budget_left < remaining)
                                budget_exhausted = true;
                        continue;
                }

                xs->tx_budget_spent += used;
                sum_batch.tx_descs += curr_batch.tx_descs;
                sum_batch.reclaim_descs = curr_batch.reclaim_descs;
        }

        cq_descs_after = xsk_tx_batch_cq_descs(&sum_batch);

        if (sum_batch.reclaim_descs || cq_descs_after >= max_descs)
                return sum_batch;

        /* Continue filling the batch while this pass made progress */
        if (cq_descs_before != cq_descs_after)
                goto again;

        if (!budget_exhausted)
                return sum_batch;

        list_for_each_entry_rcu(xs, &pool->xsk_tx_list, tx_list)
                xs->tx_budget_spent = 0;
        goto again;
}

u32 xsk_tx_peek_release_desc_batch(struct xsk_buff_pool *pool, u32 nb_pkts)
{
        struct xsk_tx_batch batch = {};
        struct xdp_sock *xs;
        bool umem_shared;

        rcu_read_lock();
        if (unlikely(READ_ONCE(pool->reclaim_descs)))
                goto out;

        xs = list_first_or_null_rcu(&pool->xsk_tx_list, struct xdp_sock,
                                    tx_list);
        if (!xs)
                goto out;

        nb_pkts = min(nb_pkts, pool->tx_descs_nentries);
        if (!nb_pkts)
                goto out;

        umem_shared = !list_is_singular(&pool->xsk_tx_list);

        if (umem_shared && !(pool->umem->flags & XDP_UMEM_SG_FLAG)) {
                rcu_read_unlock();
                return xsk_tx_peek_release_fallback(pool, nb_pkts);
        }

        /* This is the backpressure mechanism for the Tx path. Try to
         * reserve space in the completion queue for all packets, but
         * if there are fewer slots available, just process that many
         * packets. This avoids having to implement any buffering in
         * the Tx path.
         */
        nb_pkts = xskq_prod_nb_free(pool->cq, nb_pkts);
        if (!nb_pkts)
                goto out;

        batch = umem_shared ?
                xsk_tx_peek_release_shared_desc_batch(pool, nb_pkts) :
                __xsk_tx_peek_release_desc_batch(pool, xs,
                                                 pool->tx_descs,
                                                 nb_pkts);
        xsk_tx_commit_batch(pool, &batch);

out:
        rcu_read_unlock();
        return batch.tx_descs;
}
EXPORT_SYMBOL(xsk_tx_peek_release_desc_batch);

static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
{
        struct net_device *dev = xs->dev;

        return dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
}

static int xsk_cq_reserve_locked(struct xsk_buff_pool *pool)
{
        int ret;

        spin_lock(&pool->cq->cq_cached_prod_lock);
        ret = xskq_prod_reserve(pool->cq);
        spin_unlock(&pool->cq->cq_cached_prod_lock);

        return ret;
}

static bool xsk_skb_destructor_is_addr(struct sk_buff *skb)
{
        return (uintptr_t)skb_shinfo(skb)->destructor_arg & 0x1UL;
}

static u64 xsk_skb_destructor_get_addr(struct sk_buff *skb)
{
        return (u64)((uintptr_t)skb_shinfo(skb)->destructor_arg & ~0x1UL);
}

static struct xsk_addrs *__xsk_addrs_alloc(struct sk_buff *skb, u64 addr)
{
        struct xsk_addrs *xsk_addr;

        xsk_addr = kmem_cache_zalloc(xsk_tx_generic_cache, GFP_KERNEL);
        if (unlikely(!xsk_addr))
                return NULL;

        xsk_addr->addrs[0] = addr;
        skb_shinfo(skb)->destructor_arg = (void *)xsk_addr;
        return xsk_addr;
}

static struct xsk_addrs *xsk_addrs_alloc(struct sk_buff *skb)
{
        struct xsk_addrs *xsk_addr;

        if (!xsk_skb_destructor_is_addr(skb))
                return (struct xsk_addrs *)skb_shinfo(skb)->destructor_arg;

        xsk_addr = __xsk_addrs_alloc(skb, xsk_skb_destructor_get_addr(skb));
        if (likely(xsk_addr))
                xsk_addr->num_descs = 1;
        return xsk_addr;
}

static int xsk_skb_destructor_set_addr(struct sk_buff *skb, u64 addr)
{
        if (IS_ENABLED(CONFIG_64BIT)) {
                skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t)addr | 0x1UL);
                return 0;
        }

        if (unlikely(!__xsk_addrs_alloc(skb, addr)))
                return -ENOMEM;
        return 0;
}

static void xsk_inc_num_desc(struct sk_buff *skb)
{
        struct xsk_addrs *xsk_addr;

        if (!xsk_skb_destructor_is_addr(skb)) {
                xsk_addr = (struct xsk_addrs *)skb_shinfo(skb)->destructor_arg;
                xsk_addr->num_descs++;
        }
}

static u32 xsk_get_num_desc(struct sk_buff *skb)
{
        struct xsk_addrs *xsk_addr;

        if (xsk_skb_destructor_is_addr(skb))
                return 1;

        xsk_addr = (struct xsk_addrs *)skb_shinfo(skb)->destructor_arg;

        return xsk_addr->num_descs;
}

static void xsk_cq_submit_addr_locked(struct xsk_buff_pool *pool,
                                      struct sk_buff *skb)
{
        u32 num_descs = xsk_get_num_desc(skb);
        struct xsk_addrs *xsk_addr;
        u32 descs_processed = 0;
        unsigned long flags;
        u32 idx, i;

        spin_lock_irqsave(&pool->cq_prod_lock, flags);
        idx = xskq_get_prod(pool->cq);

        if (unlikely(!xsk_skb_destructor_is_addr(skb))) {
                xsk_addr = (struct xsk_addrs *)skb_shinfo(skb)->destructor_arg;

                for (i = 0; i < num_descs; i++) {
                        xskq_prod_write_addr(pool->cq, idx + descs_processed,
                                             xsk_addr->addrs[i]);
                        descs_processed++;
                }
                kmem_cache_free(xsk_tx_generic_cache, xsk_addr);
        } else {
                xskq_prod_write_addr(pool->cq, idx,
                                     xsk_skb_destructor_get_addr(skb));
                descs_processed++;
        }
        xskq_prod_submit_n(pool->cq, descs_processed);
        spin_unlock_irqrestore(&pool->cq_prod_lock, flags);
}

static void xsk_cq_submit_addr_single_locked(struct xsk_buff_pool *pool,
                                             struct xdp_desc *desc)
{
        unsigned long flags;
        u32 idx;

        spin_lock_irqsave(&pool->cq_prod_lock, flags);
        idx = xskq_get_prod(pool->cq);
        xskq_prod_write_addr(pool->cq, idx, desc->addr);
        xskq_prod_submit_n(pool->cq, 1);
        spin_unlock_irqrestore(&pool->cq_prod_lock, flags);
}

static void xsk_cq_cancel_locked(struct xsk_buff_pool *pool, u32 n)
{
        spin_lock(&pool->cq->cq_cached_prod_lock);
        xskq_prod_cancel_n(pool->cq, n);
        spin_unlock(&pool->cq->cq_cached_prod_lock);
}

INDIRECT_CALLABLE_SCOPE
void xsk_destruct_skb(struct sk_buff *skb)
{
        struct xsk_tx_metadata_compl *compl = &skb_shinfo(skb)->xsk_meta;

        if (compl->tx_timestamp) {
                /* sw completion timestamp, not a real one */
                *compl->tx_timestamp = ktime_get_tai_fast_ns();
        }

        xsk_cq_submit_addr_locked(xdp_sk(skb->sk)->pool, skb);
        sock_wfree(skb);
}

static int xsk_skb_init_misc(struct sk_buff *skb, struct xdp_sock *xs,
                             u64 addr)
{
        int err;

        err = xsk_skb_destructor_set_addr(skb, addr);
        if (unlikely(err))
                return err;

        skb->dev = xs->dev;
        skb->priority = READ_ONCE(xs->sk.sk_priority);
        skb->mark = READ_ONCE(xs->sk.sk_mark);
        skb->destructor = xsk_destruct_skb;
        return 0;
}

static void xsk_consume_skb(struct sk_buff *skb)
{
        struct xdp_sock *xs = xdp_sk(skb->sk);
        u32 num_descs = xsk_get_num_desc(skb);
        struct xsk_addrs *xsk_addr;

        if (unlikely(!xsk_skb_destructor_is_addr(skb))) {
                xsk_addr = (struct xsk_addrs *)skb_shinfo(skb)->destructor_arg;
                kmem_cache_free(xsk_tx_generic_cache, xsk_addr);
        }

        skb->destructor = sock_wfree;
        xsk_cq_cancel_locked(xs->pool, num_descs);
        /* Free skb without triggering the perf drop trace */
        consume_skb(skb);
        xs->skb = NULL;
}

static void xsk_drop_skb(struct sk_buff *skb)
{
        struct xdp_sock *xs = xdp_sk(skb->sk);

        xs->tx->invalid_descs += xsk_get_num_desc(skb);
        consume_skb(skb);
        xs->skb = NULL;
}

static int xsk_skb_metadata(struct sk_buff *skb, void *buffer,
                            struct xdp_desc *desc, struct xsk_buff_pool *pool,
                            u32 hr)
{
        struct xsk_tx_metadata *meta = NULL;
        u16 csum_start, csum_offset;

        if (unlikely(pool->tx_metadata_len == 0))
                return -EINVAL;

        meta = buffer - pool->tx_metadata_len;
        if (unlikely(!xsk_buff_valid_tx_metadata(meta)))
                return -EINVAL;

        if (meta->flags & XDP_TXMD_FLAGS_CHECKSUM) {
                csum_start = READ_ONCE(meta->request.csum_start);
                csum_offset = READ_ONCE(meta->request.csum_offset);

                if (unlikely(csum_start + csum_offset +
                             sizeof(__sum16) > desc->len))
                        return -EINVAL;

                skb->csum_start = hr + csum_start;
                skb->csum_offset = csum_offset;
                skb->ip_summed = CHECKSUM_PARTIAL;

                if (unlikely(pool->tx_sw_csum)) {
                        int err;

                        err = skb_checksum_help(skb);
                        if (err)
                                return err;
                }
        }

        if (meta->flags & XDP_TXMD_FLAGS_LAUNCH_TIME)
                skb->skb_mstamp_ns = meta->request.launch_time;
        xsk_tx_metadata_to_compl(meta, &skb_shinfo(skb)->xsk_meta);

        return 0;
}

static struct sk_buff *xsk_build_skb_zerocopy(struct xdp_sock *xs,
                                              struct xdp_desc *desc)
{
        struct xsk_buff_pool *pool = xs->pool;
        u32 hr, len, ts, offset, copy, copied;
        struct sk_buff *skb = xs->skb;
        struct page *page;
        void *buffer;
        int err, i;
        u64 addr;

        addr = desc->addr;
        buffer = xsk_buff_raw_get_data(pool, addr);

        if (!skb) {
                hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(xs->dev->needed_headroom));

                skb = sock_alloc_send_skb(&xs->sk, hr, 1, &err);
                if (unlikely(!skb))
                        return ERR_PTR(err);

                skb_reserve(skb, hr);
                if (desc->options & XDP_TX_METADATA) {
                        err = xsk_skb_metadata(skb, buffer, desc, pool, hr);
                        if (unlikely(err)) {
                                kfree_skb(skb);
                                return ERR_PTR(err);
                        }
                }
        } else {
                struct xsk_addrs *xsk_addr;

                xsk_addr = xsk_addrs_alloc(skb);
                if (!xsk_addr)
                        return ERR_PTR(-ENOMEM);

                /* in case of -EOVERFLOW that could happen below,
                 * xsk_drop_skb() will release this node as whole skb
                 * would be dropped, which implies freeing all list elements
                 */
                xsk_addr->addrs[xsk_addr->num_descs] = desc->addr;
        }

        len = desc->len;
        ts = pool->unaligned ? len : pool->chunk_size;

        offset = offset_in_page(buffer);
        addr = buffer - pool->addrs;

        for (copied = 0, i = skb_shinfo(skb)->nr_frags; copied < len; i++) {
                if (unlikely(i >= MAX_SKB_FRAGS)) {
                        if (!xs->skb)
                                kfree_skb(skb);
                        return ERR_PTR(-EOVERFLOW);
                }

                page = pool->umem->pgs[addr >> PAGE_SHIFT];
                get_page(page);

                copy = min_t(u32, PAGE_SIZE - offset, len - copied);
                skb_fill_page_desc(skb, i, page, offset, copy);

                copied += copy;
                addr += copy;
                offset = 0;
        }

        skb->len += len;
        skb->data_len += len;
        skb->truesize += ts;

        refcount_add(ts, &xs->sk.sk_wmem_alloc);

        return skb;
}

static struct sk_buff *xsk_build_skb(struct xdp_sock *xs,
                                     struct xdp_desc *desc)
{
        struct net_device *dev = xs->dev;
        struct sk_buff *skb = xs->skb;
        int err;

        if (dev->priv_flags & IFF_TX_SKB_NO_LINEAR) {
                skb = xsk_build_skb_zerocopy(xs, desc);
                if (IS_ERR(skb)) {
                        err = PTR_ERR(skb);
                        skb = NULL;
                        goto free_err;
                }
        } else {
                u32 hr, tr, len;
                void *buffer;

                buffer = xsk_buff_raw_get_data(xs->pool, desc->addr);
                len = desc->len;

                if (!skb) {
                        hr = max(NET_SKB_PAD, L1_CACHE_ALIGN(dev->needed_headroom));
                        tr = dev->needed_tailroom;
                        skb = sock_alloc_send_skb(&xs->sk, hr + len + tr, 1, &err);
                        if (unlikely(!skb))
                                goto free_err;

                        skb_reserve(skb, hr);
                        skb_put(skb, len);

                        err = skb_store_bits(skb, 0, buffer, len);
                        if (unlikely(err))
                                goto free_err;

                        if (desc->options & XDP_TX_METADATA) {
                                err = xsk_skb_metadata(skb, buffer, desc,
                                                       xs->pool, hr);
                                if (unlikely(err))
                                        goto free_err;
                        }
                } else {
                        int nr_frags = skb_shinfo(skb)->nr_frags;
                        struct xsk_addrs *xsk_addr;
                        struct page *page;
                        u8 *vaddr;

                        xsk_addr = xsk_addrs_alloc(skb);
                        if (!xsk_addr) {
                                err = -ENOMEM;
                                goto free_err;
                        }

                        xsk_addr->addrs[xsk_addr->num_descs] = desc->addr;

                        if (unlikely(nr_frags == (MAX_SKB_FRAGS - 1) && xp_mb_desc(desc))) {
                                err = -EOVERFLOW;
                                goto free_err;
                        }

                        page = alloc_page(xs->sk.sk_allocation);
                        if (unlikely(!page)) {
                                err = -EAGAIN;
                                goto free_err;
                        }

                        vaddr = kmap_local_page(page);
                        memcpy(vaddr, buffer, len);
                        kunmap_local(vaddr);

                        skb_add_rx_frag(skb, nr_frags, page, 0, len, PAGE_SIZE);
                        refcount_add(PAGE_SIZE, &xs->sk.sk_wmem_alloc);
                }
        }

        if (!xs->skb) {
                err = xsk_skb_init_misc(skb, xs, desc->addr);
                if (unlikely(err))
                        goto free_err;
        }
        xsk_inc_num_desc(skb);

        return skb;

free_err:
        if (skb && !xs->skb)
                kfree_skb(skb);

        if (err == -EOVERFLOW) {
                if (xs->skb) {
                        /* Drop the packet */
                        xsk_inc_num_desc(xs->skb);
                        xsk_drop_skb(xs->skb);
                } else {
                        xsk_cq_cancel_locked(xs->pool, 1);
                        xs->tx->invalid_descs++;
                }
                xskq_cons_release(xs->tx);
        } else {
                /* Let application retry */
                xsk_cq_cancel_locked(xs->pool, 1);
        }

        return ERR_PTR(err);
}

static int __xsk_generic_xmit(struct sock *sk)
{
        struct xdp_sock *xs = xdp_sk(sk);
        struct xdp_desc desc;
        struct sk_buff *skb;
        u32 cached_cons;
        u32 max_batch;
        int err = 0;

        mutex_lock(&xs->mutex);
        cached_cons = xs->tx->cached_cons;

        /* Since we dropped the RCU read lock, the socket state might have changed. */
        if (unlikely(!xsk_is_bound(xs))) {
                err = -ENXIO;
                goto out;
        }

        if (xs->queue_id >= xs->dev->real_num_tx_queues)
                goto out;

        max_batch = READ_ONCE(xs->max_tx_budget);
        while (xskq_cons_peek_desc(xs->tx, &desc, xs->pool)) {
                if (max_batch-- == 0) {
                        err = -EAGAIN;
                        goto out;
                }

                /* This is the backpressure mechanism for the Tx path.
                 * Reserve space in the completion queue and only proceed
                 * if there is space in it. This avoids having to implement
                 * any buffering in the Tx path.
                 */
                err = xsk_cq_reserve_locked(xs->pool);
                if (err) {
                        err = -EAGAIN;
                        goto out;
                }

                if (unlikely(xs->drain_cont)) {
                        xsk_cq_submit_addr_single_locked(xs->pool, &desc);
                        xs->tx->invalid_descs++;
                        xskq_cons_release(xs->tx);
                        xs->drain_cont = xp_mb_desc(&desc);
                        continue;
                }

                skb = xsk_build_skb(xs, &desc);
                if (IS_ERR(skb)) {
                        err = PTR_ERR(skb);
                        if (err != -EOVERFLOW)
                                goto out;
                        if (xp_mb_desc(&desc))
                                xs->drain_cont = true;
                        err = 0;
                        continue;
                }

                xskq_cons_release(xs->tx);

                if (xp_mb_desc(&desc)) {
                        xs->skb = skb;
                        continue;
                }

                err = __dev_direct_xmit(skb, xs->queue_id);
                if  (err == NETDEV_TX_BUSY) {
                        /* Tell user-space to retry the send */
                        xskq_cons_cancel_n(xs->tx, xsk_get_num_desc(skb));
                        xsk_consume_skb(skb);
                        err = -EAGAIN;
                        goto out;
                }

                /* Ignore NET_XMIT_CN as packet might have been sent */
                if (err == NET_XMIT_DROP) {
                        /* SKB completed but not sent */
                        err = -EBUSY;
                        xs->skb = NULL;
                        goto out;
                }

                xs->skb = NULL;
        }

        if (xskq_has_descs(xs->tx)) {
                bool drain = xs->skb || xs->drain_cont || xp_mb_desc(&desc);

                err = xsk_cq_reserve_locked(xs->pool);
                if (err) {
                        xs->tx->invalid_descs--;
                        if (xs->skb)
                                xsk_drop_skb(xs->skb);
                        xs->drain_cont = drain;
                        err = -EAGAIN;
                        goto out;
                }

                if (xs->skb)
                        xsk_drop_skb(xs->skb);

                xsk_cq_submit_addr_single_locked(xs->pool, &desc);

                xskq_cons_release(xs->tx);
                xs->drain_cont = xp_mb_desc(&desc);
        }

out:
        if (xs->tx->cached_cons != cached_cons)
                __xsk_tx_release(xs);

        mutex_unlock(&xs->mutex);
        return err;
}

static int xsk_generic_xmit(struct sock *sk)
{
        int ret;

        /* Drop the RCU lock since the SKB path might sleep. */
        rcu_read_unlock();
        ret = __xsk_generic_xmit(sk);
        /* Reaquire RCU lock before going into common code. */
        rcu_read_lock();

        return ret;
}

static bool xsk_no_wakeup(struct sock *sk)
{
#ifdef CONFIG_NET_RX_BUSY_POLL
        /* Prefer busy-polling, skip the wakeup. */
        return READ_ONCE(sk->sk_prefer_busy_poll) && READ_ONCE(sk->sk_ll_usec) &&
                napi_id_valid(READ_ONCE(sk->sk_napi_id));
#else
        return false;
#endif
}

static int xsk_check_common(struct xdp_sock *xs)
{
        if (unlikely(!xsk_is_bound(xs)))
                return -ENXIO;
        if (unlikely(!(xs->dev->flags & IFF_UP)))
                return -ENETDOWN;

        return 0;
}

static int __xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
{
        bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        struct xsk_buff_pool *pool;
        int err;

        err = xsk_check_common(xs);
        if (err)
                return err;
        if (unlikely(need_wait))
                return -EOPNOTSUPP;
        if (unlikely(!xs->tx))
                return -ENOBUFS;

        if (sk_can_busy_loop(sk))
                sk_busy_loop(sk, 1); /* only support non-blocking sockets */

        if (xs->zc && xsk_no_wakeup(sk))
                return 0;

        pool = xs->pool;
        if (pool->cached_need_wakeup & XDP_WAKEUP_TX) {
                if (xs->zc)
                        return xsk_wakeup(xs, XDP_WAKEUP_TX);
                return xsk_generic_xmit(sk);
        }
        return 0;
}

static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
{
        int ret;

        rcu_read_lock();
        ret = __xsk_sendmsg(sock, m, total_len);
        rcu_read_unlock();

        return ret;
}

static int __xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
{
        bool need_wait = !(flags & MSG_DONTWAIT);
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        int err;

        err = xsk_check_common(xs);
        if (err)
                return err;
        if (unlikely(!xs->rx))
                return -ENOBUFS;
        if (unlikely(need_wait))
                return -EOPNOTSUPP;

        if (sk_can_busy_loop(sk))
                sk_busy_loop(sk, 1); /* only support non-blocking sockets */

        if (xsk_no_wakeup(sk))
                return 0;

        if (xs->pool->cached_need_wakeup & XDP_WAKEUP_RX && xs->zc)
                return xsk_wakeup(xs, XDP_WAKEUP_RX);
        return 0;
}

static int xsk_recvmsg(struct socket *sock, struct msghdr *m, size_t len, int flags)
{
        int ret;

        rcu_read_lock();
        ret = __xsk_recvmsg(sock, m, len, flags);
        rcu_read_unlock();

        return ret;
}

static __poll_t xsk_poll(struct file *file, struct socket *sock,
                             struct poll_table_struct *wait)
{
        __poll_t mask = 0;
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        struct xsk_buff_pool *pool;

        sock_poll_wait(file, sock, wait);

        rcu_read_lock();
        if (xsk_check_common(xs))
                goto out;

        pool = xs->pool;

        if (pool->cached_need_wakeup) {
                if (xs->zc)
                        xsk_wakeup(xs, pool->cached_need_wakeup);
                else if (xs->tx)
                        /* Poll needs to drive Tx also in copy mode */
                        xsk_generic_xmit(sk);
        }

        if (xs->rx && !xskq_prod_is_empty(xs->rx))
                mask |= EPOLLIN | EPOLLRDNORM;
        if (xs->tx && xsk_tx_writeable(xs))
                mask |= EPOLLOUT | EPOLLWRNORM;
out:
        rcu_read_unlock();
        return mask;
}

static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
                          bool umem_queue)
{
        struct xsk_queue *q;

        if (entries == 0 || *queue || !is_power_of_2(entries))
                return -EINVAL;

        q = xskq_create(entries, umem_queue);
        if (!q)
                return -ENOMEM;

        /* Make sure queue is ready before it can be seen by others */
        smp_wmb();
        WRITE_ONCE(*queue, q);
        return 0;
}

static void xsk_unbind_dev(struct xdp_sock *xs)
{
        struct net_device *dev = xs->dev;

        if (xs->state != XSK_BOUND)
                return;
        WRITE_ONCE(xs->state, XSK_UNBOUND);

        /* Wait for driver to stop using the xdp socket. */
        xp_del_xsk(xs->pool, xs);
        synchronize_net();
        dev_put(dev);
}

static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
                                              struct xdp_sock __rcu ***map_entry)
{
        struct xsk_map *map = NULL;
        struct xsk_map_node *node;

        *map_entry = NULL;

        spin_lock_bh(&xs->map_list_lock);
        node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
                                        node);
        if (node) {
                bpf_map_inc(&node->map->map);
                map = node->map;
                *map_entry = node->map_entry;
        }
        spin_unlock_bh(&xs->map_list_lock);
        return map;
}

static void xsk_delete_from_maps(struct xdp_sock *xs)
{
        /* This function removes the current XDP socket from all the
         * maps it resides in. We need to take extra care here, due to
         * the two locks involved. Each map has a lock synchronizing
         * updates to the entries, and each socket has a lock that
         * synchronizes access to the list of maps (map_list). For
         * deadlock avoidance the locks need to be taken in the order
         * "map lock"->"socket map list lock". We start off by
         * accessing the socket map list, and take a reference to the
         * map to guarantee existence between the
         * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
         * calls. Then we ask the map to remove the socket, which
         * tries to remove the socket from the map. Note that there
         * might be updates to the map between
         * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
         */
        struct xdp_sock __rcu **map_entry = NULL;
        struct xsk_map *map;

        while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
                xsk_map_try_sock_delete(map, xs, map_entry);
                bpf_map_put(&map->map);
        }
}

static int xsk_release(struct socket *sock)
{
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        struct net *net;

        if (!sk)
                return 0;

        net = sock_net(sk);

        if (xs->skb)
                xsk_drop_skb(xs->skb);

        mutex_lock(&net->xdp.lock);
        sk_del_node_init_rcu(sk);
        mutex_unlock(&net->xdp.lock);

        sock_prot_inuse_add(net, sk->sk_prot, -1);

        xsk_delete_from_maps(xs);
        mutex_lock(&xs->mutex);
        xsk_unbind_dev(xs);
        mutex_unlock(&xs->mutex);

        xskq_destroy(xs->rx);
        xskq_destroy(xs->tx);
        xskq_destroy(xs->fq_tmp);
        xskq_destroy(xs->cq_tmp);

        sock_orphan(sk);
        sock->sk = NULL;

        sock_put(sk);

        return 0;
}

static struct socket *xsk_lookup_xsk_from_fd(int fd)
{
        struct socket *sock;
        int err;

        sock = sockfd_lookup(fd, &err);
        if (!sock)
                return ERR_PTR(-ENOTSOCK);

        if (sock->sk->sk_family != PF_XDP) {
                sockfd_put(sock);
                return ERR_PTR(-ENOPROTOOPT);
        }

        return sock;
}

static bool xsk_validate_queues(struct xdp_sock *xs)
{
        return xs->fq_tmp && xs->cq_tmp;
}

static int xsk_bind(struct socket *sock, struct sockaddr_unsized *addr, int addr_len)
{
        struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        struct net_device *dev;
        int bound_dev_if;
        u32 flags, qid;
        int err = 0;

        if (addr_len < sizeof(struct sockaddr_xdp))
                return -EINVAL;
        if (sxdp->sxdp_family != AF_XDP)
                return -EINVAL;

        flags = sxdp->sxdp_flags;
        if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
                      XDP_USE_NEED_WAKEUP | XDP_USE_SG))
                return -EINVAL;

        bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
        if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
                return -EINVAL;

        rtnl_lock();
        mutex_lock(&xs->mutex);
        if (xs->state != XSK_READY) {
                err = -EBUSY;
                goto out_release;
        }

        dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
        if (!dev) {
                err = -ENODEV;
                goto out_release;
        }

        netdev_lock_ops(dev);

        if (!xs->rx && !xs->tx) {
                err = -EINVAL;
                goto out_unlock;
        }

        qid = sxdp->sxdp_queue_id;

        if (flags & XDP_SHARED_UMEM) {
                struct xdp_sock *umem_xs;
                struct socket *sock;

                if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
                    (flags & XDP_USE_NEED_WAKEUP) || (flags & XDP_USE_SG)) {
                        /* Cannot specify flags for shared sockets. */
                        err = -EINVAL;
                        goto out_unlock;
                }

                if (xs->umem) {
                        /* We have already our own. */
                        err = -EINVAL;
                        goto out_unlock;
                }

                sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
                if (IS_ERR(sock)) {
                        err = PTR_ERR(sock);
                        goto out_unlock;
                }

                umem_xs = xdp_sk(sock->sk);
                if (!xsk_is_bound(umem_xs)) {
                        err = -EBADF;
                        sockfd_put(sock);
                        goto out_unlock;
                }

                if (umem_xs->queue_id != qid || umem_xs->dev != dev) {
                        /* One fill and completion ring required for each queue id. */
                        if (!xsk_validate_queues(xs)) {
                                err = -EINVAL;
                                sockfd_put(sock);
                                goto out_unlock;
                        }

                        /* Share the umem with another socket on another qid
                         * and/or device.
                         */
                        xs->pool = xp_create_and_assign_umem(xs,
                                                             umem_xs->umem,
                                                             dev->xdp_zc_max_segs);
                        if (!xs->pool) {
                                err = -ENOMEM;
                                sockfd_put(sock);
                                goto out_unlock;
                        }

                        err = xp_assign_dev_shared(xs->pool, umem_xs, dev,
                                                   qid);
                        if (err) {
                                xp_destroy(xs->pool);
                                xs->pool = NULL;
                                sockfd_put(sock);
                                goto out_unlock;
                        }
                } else {
                        /* Share the buffer pool with the other socket. */
                        if (xs->fq_tmp || xs->cq_tmp) {
                                /* Do not allow setting your own fq or cq. */
                                err = -EINVAL;
                                sockfd_put(sock);
                                goto out_unlock;
                        }

                        xp_get_pool(umem_xs->pool);
                        xs->pool = umem_xs->pool;

                        /* If underlying shared umem was created without Tx
                         * ring, allocate Tx descs array that Tx batching API
                         * utilizes
                         */
                        if (xs->tx && !xs->pool->tx_descs) {
                                err = xp_alloc_tx_descs(xs->pool, xs,
                                                        dev->xdp_zc_max_segs);
                                if (err) {
                                        xp_put_pool(xs->pool);
                                        xs->pool = NULL;
                                        sockfd_put(sock);
                                        goto out_unlock;
                                }
                        }
                }

                xdp_get_umem(umem_xs->umem);
                WRITE_ONCE(xs->umem, umem_xs->umem);
                sockfd_put(sock);
        } else if (!xs->umem || !xsk_validate_queues(xs)) {
                err = -EINVAL;
                goto out_unlock;
        } else {
                /* This xsk has its own umem. */
                xs->pool = xp_create_and_assign_umem(xs, xs->umem,
                                                     dev->xdp_zc_max_segs);

                if (!xs->pool) {
                        err = -ENOMEM;
                        goto out_unlock;
                }

                err = xp_assign_dev(xs->pool, dev, qid, flags);
                if (err) {
                        xp_destroy(xs->pool);
                        xs->pool = NULL;
                        goto out_unlock;
                }
        }

        /* FQ and CQ are now owned by the buffer pool and cleaned up with it. */
        xs->fq_tmp = NULL;
        xs->cq_tmp = NULL;

        xs->dev = dev;
        xs->zc = xs->umem->zc;
        xs->sg = !!(xs->umem->flags & XDP_UMEM_SG_FLAG);
        xs->queue_id = qid;
        xp_add_xsk(xs->pool, xs);

        if (qid < dev->real_num_rx_queues) {
                struct netdev_rx_queue *rxq;

                rxq = __netif_get_rx_queue(dev, qid);
                if (rxq->napi)
                        __sk_mark_napi_id_once(sk, rxq->napi->napi_id);
        }

out_unlock:
        if (err) {
                dev_put(dev);
        } else {
                /* Matches smp_rmb() in bind() for shared umem
                 * sockets, and xsk_is_bound().
                 */
                smp_wmb();
                WRITE_ONCE(xs->state, XSK_BOUND);
        }
        netdev_unlock_ops(dev);
out_release:
        mutex_unlock(&xs->mutex);
        rtnl_unlock();
        return err;
}

struct xdp_umem_reg_v1 {
        __u64 addr; /* Start of packet data area */
        __u64 len; /* Length of packet data area */
        __u32 chunk_size;
        __u32 headroom;
};

static int xsk_setsockopt(struct socket *sock, int level, int optname,
                          sockptr_t optval, unsigned int optlen)
{
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        int err;

        if (level != SOL_XDP)
                return -ENOPROTOOPT;

        switch (optname) {
        case XDP_RX_RING:
        case XDP_TX_RING:
        {
                struct xsk_queue **q;
                int entries;

                if (optlen < sizeof(entries))
                        return -EINVAL;
                if (copy_from_sockptr(&entries, optval, sizeof(entries)))
                        return -EFAULT;

                mutex_lock(&xs->mutex);
                if (xs->state != XSK_READY) {
                        mutex_unlock(&xs->mutex);
                        return -EBUSY;
                }
                q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
                err = xsk_init_queue(entries, q, false);
                if (!err && optname == XDP_TX_RING)
                        /* Tx needs to be explicitly woken up the first time */
                        xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
                mutex_unlock(&xs->mutex);
                return err;
        }
        case XDP_UMEM_REG:
        {
                size_t mr_size = sizeof(struct xdp_umem_reg);
                struct xdp_umem_reg mr = {};
                struct xdp_umem *umem;

                if (optlen < sizeof(struct xdp_umem_reg_v1))
                        return -EINVAL;
                else if (optlen < sizeof(mr))
                        mr_size = sizeof(struct xdp_umem_reg_v1);

                BUILD_BUG_ON(sizeof(struct xdp_umem_reg_v1) >= sizeof(struct xdp_umem_reg));

                /* Make sure the last field of the struct doesn't have
                 * uninitialized padding. All padding has to be explicit
                 * and has to be set to zero by the userspace to make
                 * struct xdp_umem_reg extensible in the future.
                 */
                BUILD_BUG_ON(offsetof(struct xdp_umem_reg, tx_metadata_len) +
                             sizeof_field(struct xdp_umem_reg, tx_metadata_len) !=
                             sizeof(struct xdp_umem_reg));

                if (copy_from_sockptr(&mr, optval, mr_size))
                        return -EFAULT;

                mutex_lock(&xs->mutex);
                if (xs->state != XSK_READY || xs->umem) {
                        mutex_unlock(&xs->mutex);
                        return -EBUSY;
                }

                umem = xdp_umem_create(&mr);
                if (IS_ERR(umem)) {
                        mutex_unlock(&xs->mutex);
                        return PTR_ERR(umem);
                }

                /* Make sure umem is ready before it can be seen by others */
                smp_wmb();
                WRITE_ONCE(xs->umem, umem);
                mutex_unlock(&xs->mutex);
                return 0;
        }
        case XDP_UMEM_FILL_RING:
        case XDP_UMEM_COMPLETION_RING:
        {
                struct xsk_queue **q;
                int entries;

                if (optlen < sizeof(entries))
                        return -EINVAL;
                if (copy_from_sockptr(&entries, optval, sizeof(entries)))
                        return -EFAULT;

                mutex_lock(&xs->mutex);
                if (xs->state != XSK_READY) {
                        mutex_unlock(&xs->mutex);
                        return -EBUSY;
                }

                q = (optname == XDP_UMEM_FILL_RING) ? &xs->fq_tmp :
                        &xs->cq_tmp;
                err = xsk_init_queue(entries, q, true);
                mutex_unlock(&xs->mutex);
                return err;
        }
        case XDP_MAX_TX_SKB_BUDGET:
        {
                unsigned int budget;

                if (optlen != sizeof(budget))
                        return -EINVAL;
                if (copy_from_sockptr(&budget, optval, sizeof(budget)))
                        return -EFAULT;
                if (!xs->tx ||
                    budget < TX_BATCH_SIZE || budget > xs->tx->nentries)
                        return -EACCES;

                WRITE_ONCE(xs->max_tx_budget, budget);
                return 0;
        }
        default:
                break;
        }

        return -ENOPROTOOPT;
}

static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
{
        ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
        ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
        ring->desc = offsetof(struct xdp_rxtx_ring, desc);
}

static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
{
        ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
        ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
        ring->desc = offsetof(struct xdp_umem_ring, desc);
}

struct xdp_statistics_v1 {
        __u64 rx_dropped;
        __u64 rx_invalid_descs;
        __u64 tx_invalid_descs;
};

static int xsk_getsockopt(struct socket *sock, int level, int optname,
                          sockopt_t *opt)
{
        struct sock *sk = sock->sk;
        struct xdp_sock *xs = xdp_sk(sk);
        int len;

        if (level != SOL_XDP)
                return -ENOPROTOOPT;

        len = opt->optlen;
        if (len < 0)
                return -EINVAL;

        switch (optname) {
        case XDP_STATISTICS:
        {
                struct xdp_statistics stats = {};
                bool extra_stats = true;
                size_t stats_size;

                if (len < sizeof(struct xdp_statistics_v1)) {
                        return -EINVAL;
                } else if (len < sizeof(stats)) {
                        extra_stats = false;
                        stats_size = sizeof(struct xdp_statistics_v1);
                } else {
                        stats_size = sizeof(stats);
                }

                mutex_lock(&xs->mutex);
                stats.rx_dropped = xs->rx_dropped;
                if (extra_stats) {
                        stats.rx_ring_full = xs->rx_queue_full;
                        stats.rx_fill_ring_empty_descs =
                                xs->pool ? xskq_nb_queue_empty_descs(xs->pool->fq) : 0;
                        stats.tx_ring_empty_descs = xskq_nb_queue_empty_descs(xs->tx);
                } else {
                        stats.rx_dropped += xs->rx_queue_full;
                }
                stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
                stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
                mutex_unlock(&xs->mutex);

                if (copy_to_iter(&stats, stats_size, &opt->iter_out) !=
                    stats_size)
                        return -EFAULT;
                opt->optlen = stats_size;

                return 0;
        }
        case XDP_MMAP_OFFSETS:
        {
                struct xdp_mmap_offsets off;
                struct xdp_mmap_offsets_v1 off_v1;
                bool flags_supported = true;
                void *to_copy;

                if (len < sizeof(off_v1))
                        return -EINVAL;
                else if (len < sizeof(off))
                        flags_supported = false;

                if (flags_supported) {
                        /* xdp_ring_offset is identical to xdp_ring_offset_v1
                         * except for the flags field added to the end.
                         */
                        xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
                                               &off.rx);
                        xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
                                               &off.tx);
                        xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
                                               &off.fr);
                        xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
                                               &off.cr);
                        off.rx.flags = offsetof(struct xdp_rxtx_ring,
                                                ptrs.flags);
                        off.tx.flags = offsetof(struct xdp_rxtx_ring,
                                                ptrs.flags);
                        off.fr.flags = offsetof(struct xdp_umem_ring,
                                                ptrs.flags);
                        off.cr.flags = offsetof(struct xdp_umem_ring,
                                                ptrs.flags);

                        len = sizeof(off);
                        to_copy = &off;
                } else {
                        xsk_enter_rxtx_offsets(&off_v1.rx);
                        xsk_enter_rxtx_offsets(&off_v1.tx);
                        xsk_enter_umem_offsets(&off_v1.fr);
                        xsk_enter_umem_offsets(&off_v1.cr);

                        len = sizeof(off_v1);
                        to_copy = &off_v1;
                }

                if (copy_to_iter(to_copy, len, &opt->iter_out) != len)
                        return -EFAULT;
                opt->optlen = len;

                return 0;
        }
        case XDP_OPTIONS:
        {
                struct xdp_options opts = {};

                if (len < sizeof(opts))
                        return -EINVAL;

                mutex_lock(&xs->mutex);
                if (xs->zc)
                        opts.flags |= XDP_OPTIONS_ZEROCOPY;
                mutex_unlock(&xs->mutex);

                len = sizeof(opts);
                if (copy_to_iter(&opts, len, &opt->iter_out) != len)
                        return -EFAULT;
                opt->optlen = len;

                return 0;
        }
        default:
                break;
        }

        return -EOPNOTSUPP;
}

static int xsk_mmap(struct file *file, struct socket *sock,
                    struct vm_area_struct *vma)
{
        loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
        unsigned long size = vma->vm_end - vma->vm_start;
        struct xdp_sock *xs = xdp_sk(sock->sk);
        int state = READ_ONCE(xs->state);
        struct xsk_queue *q = NULL;

        if (state != XSK_READY && state != XSK_BOUND)
                return -EBUSY;

        if (offset == XDP_PGOFF_RX_RING) {
                q = READ_ONCE(xs->rx);
        } else if (offset == XDP_PGOFF_TX_RING) {
                q = READ_ONCE(xs->tx);
        } else {
                /* Matches the smp_wmb() in XDP_UMEM_REG */
                smp_rmb();
                if (offset == XDP_UMEM_PGOFF_FILL_RING)
                        q = state == XSK_READY ? READ_ONCE(xs->fq_tmp) :
                                                 READ_ONCE(xs->pool->fq);
                else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
                        q = state == XSK_READY ? READ_ONCE(xs->cq_tmp) :
                                                 READ_ONCE(xs->pool->cq);
        }

        if (!q)
                return -EINVAL;

        /* Matches the smp_wmb() in xsk_init_queue */
        smp_rmb();
        if (size > q->ring_vmalloc_size)
                return -EINVAL;

        return remap_vmalloc_range(vma, q->ring, 0);
}

static int xsk_notifier(struct notifier_block *this,
                        unsigned long msg, void *ptr)
{
        struct net_device *dev = netdev_notifier_info_to_dev(ptr);
        struct net *net = dev_net(dev);
        struct sock *sk;

        switch (msg) {
        case NETDEV_UNREGISTER:
                mutex_lock(&net->xdp.lock);
                sk_for_each(sk, &net->xdp.list) {
                        struct xdp_sock *xs = xdp_sk(sk);

                        mutex_lock(&xs->mutex);
                        if (xs->dev == dev) {
                                sk->sk_err = ENETDOWN;
                                if (!sock_flag(sk, SOCK_DEAD))
                                        sk_error_report(sk);

                                xsk_unbind_dev(xs);

                                /* Clear device references. */
                                xp_clear_dev(xs->pool);
                        }
                        mutex_unlock(&xs->mutex);
                }
                mutex_unlock(&net->xdp.lock);
                break;
        }
        return NOTIFY_DONE;
}

static struct proto xsk_proto = {
        .name =                "XDP",
        .owner =        THIS_MODULE,
        .obj_size =        sizeof(struct xdp_sock),
};

static const struct proto_ops xsk_proto_ops = {
        .family                = PF_XDP,
        .owner                = THIS_MODULE,
        .release        = xsk_release,
        .bind                = xsk_bind,
        .connect        = sock_no_connect,
        .socketpair        = sock_no_socketpair,
        .accept                = sock_no_accept,
        .getname        = sock_no_getname,
        .poll                = xsk_poll,
        .ioctl                = sock_no_ioctl,
        .listen                = sock_no_listen,
        .shutdown        = sock_no_shutdown,
        .setsockopt        = xsk_setsockopt,
        .getsockopt_iter = xsk_getsockopt,
        .sendmsg        = xsk_sendmsg,
        .recvmsg        = xsk_recvmsg,
        .mmap                = xsk_mmap,
};

static void xsk_destruct(struct sock *sk)
{
        struct xdp_sock *xs = xdp_sk(sk);

        if (!sock_flag(sk, SOCK_DEAD))
                return;

        if (!xp_put_pool(xs->pool))
                xdp_put_umem(xs->umem, !xs->pool);
}

static int xsk_create(struct net *net, struct socket *sock, int protocol,
                      int kern)
{
        struct xdp_sock *xs;
        struct sock *sk;

        if (!ns_capable(net->user_ns, CAP_NET_RAW))
                return -EPERM;
        if (sock->type != SOCK_RAW)
                return -ESOCKTNOSUPPORT;

        if (protocol)
                return -EPROTONOSUPPORT;

        sock->state = SS_UNCONNECTED;

        sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
        if (!sk)
                return -ENOBUFS;

        sock->ops = &xsk_proto_ops;

        sock_init_data(sock, sk);

        sk->sk_family = PF_XDP;

        sk->sk_destruct = xsk_destruct;

        sock_set_flag(sk, SOCK_RCU_FREE);

        xs = xdp_sk(sk);
        xs->state = XSK_READY;
        xs->max_tx_budget = TX_BATCH_SIZE;
        mutex_init(&xs->mutex);

        INIT_LIST_HEAD(&xs->map_list);
        spin_lock_init(&xs->map_list_lock);

        mutex_lock(&net->xdp.lock);
        sk_add_node_rcu(sk, &net->xdp.list);
        mutex_unlock(&net->xdp.lock);

        sock_prot_inuse_add(net, &xsk_proto, 1);

        return 0;
}

static const struct net_proto_family xsk_family_ops = {
        .family = PF_XDP,
        .create = xsk_create,
        .owner        = THIS_MODULE,
};

static struct notifier_block xsk_netdev_notifier = {
        .notifier_call        = xsk_notifier,
};

static int __net_init xsk_net_init(struct net *net)
{
        mutex_init(&net->xdp.lock);
        INIT_HLIST_HEAD(&net->xdp.list);
        return 0;
}

static void __net_exit xsk_net_exit(struct net *net)
{
        WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
}

static struct pernet_operations xsk_net_ops = {
        .init = xsk_net_init,
        .exit = xsk_net_exit,
};

static int __init xsk_init(void)
{
        int err;

        err = proto_register(&xsk_proto, 0 /* no slab */);
        if (err)
                goto out;

        err = sock_register(&xsk_family_ops);
        if (err)
                goto out_proto;

        err = register_pernet_subsys(&xsk_net_ops);
        if (err)
                goto out_sk;

        err = register_netdevice_notifier(&xsk_netdev_notifier);
        if (err)
                goto out_pernet;

        xsk_tx_generic_cache = kmem_cache_create("xsk_generic_xmit_cache",
                                                 sizeof(struct xsk_addrs),
                                                 0, SLAB_HWCACHE_ALIGN, NULL);
        if (!xsk_tx_generic_cache) {
                err = -ENOMEM;
                goto out_unreg_notif;
        }

        return 0;

out_unreg_notif:
        unregister_netdevice_notifier(&xsk_netdev_notifier);
out_pernet:
        unregister_pernet_subsys(&xsk_net_ops);
out_sk:
        sock_unregister(PF_XDP);
out_proto:
        proto_unregister(&xsk_proto);
out:
        return err;
}

fs_initcall(xsk_init);













































































































































































































































































































































































































































































































































































































    2 




    2 














1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (C) 2016 Red Hat, Inc. All rights reserved.
 *
 * This file is released under the GPL.
 */

#include "dm-core.h"
#include "dm-rq.h"

#include <linux/blk-mq.h>

#define DM_MSG_PREFIX "core-rq"

/*
 * One of these is allocated per request.
 */
struct dm_rq_target_io {
        struct mapped_device *md;
        struct dm_target *ti;
        struct request *orig, *clone;
        struct kthread_work work;
        blk_status_t error;
        union map_info info;
        struct dm_stats_aux stats_aux;
        unsigned long duration_jiffies;
        unsigned int n_sectors;
        unsigned int completed;
};

#define DM_MQ_NR_HW_QUEUES 1
#define DM_MQ_QUEUE_DEPTH 2048
static unsigned int dm_mq_nr_hw_queues = DM_MQ_NR_HW_QUEUES;
static unsigned int dm_mq_queue_depth = DM_MQ_QUEUE_DEPTH;

/*
 * Request-based DM's mempools' reserved IOs set by the user.
 */
#define RESERVED_REQUEST_BASED_IOS        256
static unsigned int reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;

unsigned int dm_get_reserved_rq_based_ios(void)
{
        return __dm_get_module_param(&reserved_rq_based_ios,
                                     RESERVED_REQUEST_BASED_IOS, DM_RESERVED_MAX_IOS);
}

static unsigned int dm_get_blk_mq_nr_hw_queues(void)
{
        return __dm_get_module_param(&dm_mq_nr_hw_queues, 1, 32);
}

static unsigned int dm_get_blk_mq_queue_depth(void)
{
        return __dm_get_module_param(&dm_mq_queue_depth,
                                     DM_MQ_QUEUE_DEPTH, BLK_MQ_MAX_DEPTH);
}

int dm_request_based(struct mapped_device *md)
{
        return queue_is_mq(md->queue);
}

void dm_start_queue(struct request_queue *q)
{
        blk_mq_unquiesce_queue(q);
        blk_mq_kick_requeue_list(q);
}

void dm_stop_queue(struct request_queue *q)
{
        blk_mq_quiesce_queue(q);
}

/*
 * Partial completion handling for request-based dm
 */
static void end_clone_bio(struct bio *clone)
{
        struct dm_rq_clone_bio_info *info =
                container_of(clone, struct dm_rq_clone_bio_info, clone);
        struct dm_rq_target_io *tio = info->tio;
        unsigned int nr_bytes = info->orig->bi_iter.bi_size;
        blk_status_t error = clone->bi_status;
        bool is_last = !clone->bi_next;

        bio_put(clone);

        if (tio->error)
                /*
                 * An error has already been detected on the request.
                 * Once error occurred, just let clone->end_io() handle
                 * the remainder.
                 */
                return;
        else if (error) {
                /*
                 * Don't notice the error to the upper layer yet.
                 * The error handling decision is made by the target driver,
                 * when the request is completed.
                 */
                tio->error = error;
                goto exit;
        }

        /*
         * I/O for the bio successfully completed.
         * Notice the data completion to the upper layer.
         */
        tio->completed += nr_bytes;

        if (!is_last)
                return;
        /*
         * At this moment we know this is the last bio of the cloned request,
         * and all cloned bios have been released, so reset the clone request's
         * bio pointer to avoid double free.
         */
        tio->clone->bio = NULL;
 exit:
        /*
         * Update the original request.
         * Do not use blk_mq_end_request() here, because it may complete
         * the original request before the clone, and break the ordering.
         */
        blk_update_request(tio->orig, BLK_STS_OK, tio->completed);
}

static struct dm_rq_target_io *tio_from_request(struct request *rq)
{
        return blk_mq_rq_to_pdu(rq);
}

static void rq_end_stats(struct mapped_device *md, struct request *orig)
{
        if (unlikely(dm_stats_used(&md->stats))) {
                struct dm_rq_target_io *tio = tio_from_request(orig);

                tio->duration_jiffies = jiffies - tio->duration_jiffies;
                dm_stats_account_io(&md->stats, rq_data_dir(orig),
                                    blk_rq_pos(orig), tio->n_sectors, true,
                                    tio->duration_jiffies, &tio->stats_aux);
        }
}

/*
 * Don't touch any member of the md after calling this function because
 * the md may be freed in dm_put() at the end of this function.
 * Or do dm_get() before calling this function and dm_put() later.
 */
static void rq_completed(struct mapped_device *md)
{
        /*
         * dm_put() must be at the end of this function. See the comment above
         */
        dm_put(md);
}

/*
 * Complete the clone and the original request.
 * Must be called without clone's queue lock held,
 * see end_clone_request() for more details.
 */
static void dm_end_request(struct request *clone, blk_status_t error)
{
        struct dm_rq_target_io *tio = clone->end_io_data;
        struct mapped_device *md = tio->md;
        struct request *rq = tio->orig;

        blk_rq_unprep_clone(clone);
        tio->ti->type->release_clone_rq(clone, NULL);

        rq_end_stats(md, rq);
        blk_mq_end_request(rq, error);
        rq_completed(md);
}

static void __dm_mq_kick_requeue_list(struct request_queue *q, unsigned long msecs)
{
        blk_mq_delay_kick_requeue_list(q, msecs);
}

void dm_mq_kick_requeue_list(struct mapped_device *md)
{
        __dm_mq_kick_requeue_list(md->queue, 0);
}
EXPORT_SYMBOL(dm_mq_kick_requeue_list);

static void dm_mq_delay_requeue_request(struct request *rq, unsigned long msecs)
{
        blk_mq_requeue_request(rq, false);
        __dm_mq_kick_requeue_list(rq->q, msecs);
}

static void dm_requeue_original_request(struct dm_rq_target_io *tio, bool delay_requeue)
{
        struct mapped_device *md = tio->md;
        struct request *rq = tio->orig;
        unsigned long delay_ms = delay_requeue ? 100 : 0;

        rq_end_stats(md, rq);
        if (tio->clone) {
                blk_rq_unprep_clone(tio->clone);
                tio->ti->type->release_clone_rq(tio->clone, NULL);
        }

        dm_mq_delay_requeue_request(rq, delay_ms);
        rq_completed(md);
}

static void dm_done(struct request *clone, blk_status_t error, bool mapped)
{
        int r = DM_ENDIO_DONE;
        struct dm_rq_target_io *tio = clone->end_io_data;
        dm_request_endio_fn rq_end_io = NULL;

        if (tio->ti) {
                rq_end_io = tio->ti->type->rq_end_io;

                if (mapped && rq_end_io)
                        r = rq_end_io(tio->ti, clone, error, &tio->info);
        }

        if (unlikely(error == BLK_STS_TARGET)) {
                if (req_op(clone) == REQ_OP_DISCARD &&
                    !clone->q->limits.max_discard_sectors)
                        blk_queue_disable_discard(tio->md->queue);
                else if (req_op(clone) == REQ_OP_WRITE_ZEROES &&
                         !clone->q->limits.max_write_zeroes_sectors)
                        blk_queue_disable_write_zeroes(tio->md->queue);
        }

        switch (r) {
        case DM_ENDIO_DONE:
                /* The target wants to complete the I/O */
                dm_end_request(clone, error);
                break;
        case DM_ENDIO_INCOMPLETE:
                /* The target will handle the I/O */
                return;
        case DM_ENDIO_REQUEUE:
                /* The target wants to requeue the I/O */
                dm_requeue_original_request(tio, false);
                break;
        case DM_ENDIO_DELAY_REQUEUE:
                /* The target wants to requeue the I/O after a delay */
                dm_requeue_original_request(tio, true);
                break;
        default:
                DMCRIT("unimplemented target endio return value: %d", r);
                BUG();
        }
}

/*
 * Request completion handler for request-based dm
 */
static void dm_softirq_done(struct request *rq)
{
        bool mapped = true;
        struct dm_rq_target_io *tio = tio_from_request(rq);
        struct request *clone = tio->clone;

        if (!clone) {
                struct mapped_device *md = tio->md;

                rq_end_stats(md, rq);
                blk_mq_end_request(rq, tio->error);
                rq_completed(md);
                return;
        }

        if (rq->rq_flags & RQF_FAILED)
                mapped = false;

        dm_done(clone, tio->error, mapped);
}

/*
 * Complete the clone and the original request with the error status
 * through softirq context.
 */
static void dm_complete_request(struct request *rq, blk_status_t error)
{
        struct dm_rq_target_io *tio = tio_from_request(rq);

        tio->error = error;
        blk_mq_complete_request(rq);
}

/*
 * Complete the not-mapped clone and the original request with the error status
 * through softirq context.
 * Target's rq_end_io() function isn't called.
 * This may be used when the target's clone_and_map_rq() function fails.
 */
static void dm_kill_unmapped_request(struct request *rq, blk_status_t error)
{
        rq->rq_flags |= RQF_FAILED;
        dm_complete_request(rq, error);
}

static enum rq_end_io_ret end_clone_request(struct request *clone,
                                            blk_status_t error,
                                            const struct io_comp_batch *iob)
{
        struct dm_rq_target_io *tio = clone->end_io_data;

        dm_complete_request(tio->orig, error);
        return RQ_END_IO_NONE;
}

static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
                                 void *data)
{
        struct dm_rq_target_io *tio = data;
        struct dm_rq_clone_bio_info *info =
                container_of(bio, struct dm_rq_clone_bio_info, clone);

        info->orig = bio_orig;
        info->tio = tio;
        bio->bi_end_io = end_clone_bio;

        return 0;
}

static int setup_clone(struct request *clone, struct request *rq,
                       struct dm_rq_target_io *tio, gfp_t gfp_mask)
{
        int r;

        r = blk_rq_prep_clone(clone, rq, &tio->md->mempools->bs, gfp_mask,
                              dm_rq_bio_constructor, tio);
        if (r)
                return r;

        clone->end_io = end_clone_request;
        clone->end_io_data = tio;

        tio->clone = clone;

        return 0;
}

static void init_tio(struct dm_rq_target_io *tio, struct request *rq,
                     struct mapped_device *md)
{
        tio->md = md;
        tio->ti = NULL;
        tio->clone = NULL;
        tio->orig = rq;
        tio->error = 0;
        tio->completed = 0;
        /*
         * Avoid initializing info for blk-mq; it passes
         * target-specific data through info.ptr
         * (see: dm_mq_init_request)
         */
        if (!md->init_tio_pdu)
                memset(&tio->info, 0, sizeof(tio->info));
}

/*
 * Returns:
 * DM_MAPIO_*       : the request has been processed as indicated
 * DM_MAPIO_REQUEUE : the original request needs to be immediately requeued
 * < 0              : the request was completed due to failure
 */
static int map_request(struct dm_rq_target_io *tio)
{
        int r;
        struct dm_target *ti = tio->ti;
        struct mapped_device *md = tio->md;
        struct request *rq = tio->orig;
        struct request *clone = NULL;
        blk_status_t ret;

        r = ti->type->clone_and_map_rq(ti, rq, &tio->info, &clone);
        switch (r) {
        case DM_MAPIO_SUBMITTED:
                /* The target has taken the I/O to submit by itself later */
                break;
        case DM_MAPIO_REMAPPED:
                if (setup_clone(clone, rq, tio, GFP_ATOMIC)) {
                        /* -ENOMEM */
                        ti->type->release_clone_rq(clone, &tio->info);
                        return DM_MAPIO_REQUEUE;
                }

                /* The target has remapped the I/O so dispatch it */
                trace_block_rq_remap(clone, disk_devt(dm_disk(md)),
                                     blk_rq_pos(rq));
                ret = blk_insert_cloned_request(clone);
                switch (ret) {
                case BLK_STS_OK:
                        break;
                case BLK_STS_RESOURCE:
                case BLK_STS_DEV_RESOURCE:
                        blk_rq_unprep_clone(clone);
                        blk_mq_cleanup_rq(clone);
                        tio->ti->type->release_clone_rq(clone, &tio->info);
                        tio->clone = NULL;
                        return DM_MAPIO_REQUEUE;
                default:
                        /* must complete clone in terms of original request */
                        dm_complete_request(rq, ret);
                }
                break;
        case DM_MAPIO_REQUEUE:
                /* The target wants to requeue the I/O */
                break;
        case DM_MAPIO_DELAY_REQUEUE:
                /* The target wants to requeue the I/O after a delay */
                dm_requeue_original_request(tio, true);
                break;
        case DM_MAPIO_KILL:
                /* The target wants to complete the I/O */
                dm_kill_unmapped_request(rq, BLK_STS_IOERR);
                break;
        default:
                DMCRIT("unimplemented target map return value: %d", r);
                BUG();
        }

        return r;
}

/* DEPRECATED: previously used for request-based merge heuristic in dm_request_fn() */
ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf)
{
        return sprintf(buf, "%u\n", 0);
}

ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
                                                     const char *buf, size_t count)
{
        return count;
}

static void dm_start_request(struct mapped_device *md, struct request *orig)
{
        blk_mq_start_request(orig);

        if (unlikely(dm_stats_used(&md->stats))) {
                struct dm_rq_target_io *tio = tio_from_request(orig);

                tio->duration_jiffies = jiffies;
                tio->n_sectors = blk_rq_sectors(orig);
                dm_stats_account_io(&md->stats, rq_data_dir(orig),
                                    blk_rq_pos(orig), tio->n_sectors, false, 0,
                                    &tio->stats_aux);
        }

        /*
         * Hold the md reference here for the in-flight I/O.
         * We can't rely on the reference count by device opener,
         * because the device may be closed during the request completion
         * when all bios are completed.
         * See the comment in rq_completed() too.
         */
        dm_get(md);
}

static int dm_mq_init_request(struct blk_mq_tag_set *set, struct request *rq,
                              unsigned int hctx_idx, int numa_node)
{
        struct mapped_device *md = set->driver_data;
        struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);

        /*
         * Must initialize md member of tio, otherwise it won't
         * be available in dm_mq_queue_rq.
         */
        tio->md = md;

        if (md->init_tio_pdu) {
                /* target-specific per-io data is immediately after the tio */
                tio->info.ptr = tio + 1;
        }

        return 0;
}

static blk_status_t dm_mq_queue_rq(struct blk_mq_hw_ctx *hctx,
                          const struct blk_mq_queue_data *bd)
{
        struct request *rq = bd->rq;
        struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
        struct mapped_device *md = tio->md;
        struct dm_target *ti = md->immutable_target;

        /*
         * blk-mq's unquiesce may come from outside events, such as
         * elevator switch, updating nr_requests or others, and request may
         * come during suspend, so simply ask for blk-mq to requeue it.
         */
        if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)))
                return BLK_STS_RESOURCE;

        if (unlikely(!ti)) {
                int srcu_idx;
                struct dm_table *map;

                map = dm_get_live_table(md, &srcu_idx);
                if (unlikely(!map)) {
                        DMERR_LIMIT("%s: mapping table unavailable, erroring io",
                                    dm_device_name(md));
                        dm_put_live_table(md, srcu_idx);
                        return BLK_STS_IOERR;
                }
                ti = dm_table_find_target(map, 0);
                dm_put_live_table(md, srcu_idx);
        }

        if (ti->type->busy && ti->type->busy(ti))
                return BLK_STS_RESOURCE;

        dm_start_request(md, rq);

        /* Init tio using md established in .init_request */
        init_tio(tio, rq, md);

        /*
         * Establish tio->ti before calling map_request().
         */
        tio->ti = ti;

        /* Direct call is fine since .queue_rq allows allocations */
        if (map_request(tio) == DM_MAPIO_REQUEUE) {
                /* Undo dm_start_request() before requeuing */
                rq_end_stats(md, rq);
                rq_completed(md);
                return BLK_STS_RESOURCE;
        }

        return BLK_STS_OK;
}

static const struct blk_mq_ops dm_mq_ops = {
        .queue_rq = dm_mq_queue_rq,
        .complete = dm_softirq_done,
        .init_request = dm_mq_init_request,
};

int dm_mq_init_request_queue(struct mapped_device *md, struct dm_table *t)
{
        struct dm_target *immutable_tgt;
        int err;

        md->tag_set = kzalloc_node(sizeof(struct blk_mq_tag_set), GFP_KERNEL, md->numa_node_id);
        if (!md->tag_set)
                return -ENOMEM;

        md->tag_set->ops = &dm_mq_ops;
        md->tag_set->queue_depth = dm_get_blk_mq_queue_depth();
        md->tag_set->numa_node = md->numa_node_id;
        md->tag_set->flags = BLK_MQ_F_STACKING;
        md->tag_set->nr_hw_queues = dm_get_blk_mq_nr_hw_queues();
        md->tag_set->driver_data = md;

        md->tag_set->cmd_size = sizeof(struct dm_rq_target_io);
        immutable_tgt = dm_table_get_immutable_target(t);
        if (immutable_tgt && immutable_tgt->per_io_data_size) {
                /* any target-specific per-io data is immediately after the tio */
                md->tag_set->cmd_size += immutable_tgt->per_io_data_size;
                md->init_tio_pdu = true;
        }

        err = blk_mq_alloc_tag_set(md->tag_set);
        if (err)
                goto out_kfree_tag_set;

        err = blk_mq_init_allocated_queue(md->tag_set, md->queue);
        if (err)
                goto out_tag_set;
        return 0;

out_tag_set:
        blk_mq_free_tag_set(md->tag_set);
out_kfree_tag_set:
        kfree(md->tag_set);
        md->tag_set = NULL;

        return err;
}

void dm_mq_cleanup_mapped_device(struct mapped_device *md)
{
        if (md->tag_set) {
                blk_mq_free_tag_set(md->tag_set);
                kfree(md->tag_set);
                md->tag_set = NULL;
        }
}

module_param(reserved_rq_based_ios, uint, 0644);
MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");

/* Unused, but preserved for userspace compatibility */
static bool use_blk_mq = true;
module_param(use_blk_mq, bool, 0644);
MODULE_PARM_DESC(use_blk_mq, "Use block multiqueue for request-based DM devices");

module_param(dm_mq_nr_hw_queues, uint, 0644);
MODULE_PARM_DESC(dm_mq_nr_hw_queues, "Number of hardware queues for request-based dm-mq devices");

module_param(dm_mq_queue_depth, uint, 0644);
MODULE_PARM_DESC(dm_mq_queue_depth, "Queue depth for request-based dm-mq devices");
















































   57 



   57 

   57 











   57 




   57 












   57 

   57 



   57 


   57 








   49 






















   54 

























   32 

   27 







   54 
   47 

   55 


   55 


   54 



   55 
   35 


   35 
   15 



   55 
   55 
   16 




   16 


   16 



    2 



   48 



   41 
   41 




   41 


   39 





   18 




   24 
   24 















   40 




   41 
   12 




   32 
   32 









   32 
    3 




    3 




    3 







    3 


    3 













    2 









    2 


    2 




    3 











   32 
    8 




    8 







    6 
    6 




































   28 
   28 







    1 


   28 

   22 


    4 
    4 















    4 


   28 


    4 
    3 



    2 









    2 






   55 






   27 





   55 





   55 
   31 
   28 


   26 


    8 
    8 



    8 

   25 




   33 

   33 
   33 

   55 













































































































































































































































































































   57 



   57 






   36 


   36 
   36 













   35 


























   57 


   30 




   57 



   57 





   57 





   57 

   57 


















   57 





   30 












   30 



   30 















   30 








   57 




























    1 







    1 

    1 


    1 










    1 




    1 
    1 












    1 


    1 






    1 








    5 




   64 













    2 


   64 









   64 
   64 



   64 
   64 

   22 









    4 


    4 



    4 
    4 

    4 












































   57 

   56 












   57 











   20 



   20 




























   57 



   58 











   56 
   57 

   57 










   57 








   57 




   57 






   57 
   20 

   20 


   20 



   57 













   57 













    4 
    4 





    4 



    4 
    4 















   57 









   30 

   39 

   57 






   57 


   57 





   60 





















   58 





   58 



   58 

   58 



   57 
   57 


   58 
   58 
   57 



    2 
   60 







    3 





    3 






    3 


    3 



    3 

    3 






   67 










   66 


   66 



    3 

   63 
   36 


   27 



   67 

   65 
   61 









   64 




   10 


    8 












   10 
    2 
   10 





   66 



















   65 










   65 
    6 
    3 


















   66 
   66 











    2 



   66 

   66 























   65 
    2 

   64 






































   65 
















   29 
   43 







   30 













   30 



   43 


   65 

   65 





    8 



   64 

















   64 








   60 


   64 















   64 
    2 

   63 

   56 





   56 
   57 

   50 
















   16 
    7 


    7 









    7 














   16 

   64 

   63 
   64 




   64 


   64 

   64 


    8 



    8 




















    4 



    3 





    1 









    4 
    4 
    1 










    4 


    1 












    1 


    3 








    3 



    3 

    3 


    3 



    3 












    3 

    1 







    3 
    2 












    3 






    3 
    2 




    2 

    3 








    3 





    3 
    3 



    1 


    1 



    1 



    1 

    2 

    2 

    4 
    1 













    5 




    5 


    5 
    5 

    5 



































    5 















































































    5 






    5 













    5 










   10 










   10 
    4 


    4 


   10 
   10 























   10 














   10 




   10 




    2 
    2 





    1 





   10 








   11 




















   10 









   18 










   18 





   18 




   18 

   17 






   18 


   15 
   18 







   18 




   18 

   15 
   15 








    4 













   18 



















   27 














   26 









   27 




   27 

    2 




   26 



   26 






   26 



    9 

   18 








   26 





















































































































   26 
    4 




   26 












    3 





    9 

    5 






    4 

    4 








   18 









   26 


   26 



   26 

   27 
   27 















    9 









    1 


   10 



   10 





    9 











    2 
    1 










    8 

    7 










    8 

    7 




    7 



    6 



    7 


    2 


    2 

    1 

    1 








    7 




    7 







    6 





    6 
    6 






    1 


    1 







    1 









    1 





    9 
    9 
























    1 

    1 




    9 


    9 

    9 








   10 





   13 
   11 

    2 







    2 



    2 





    2 











    4 








    4 

    2 




    4 
    4 







    8 



























    8 























    8 



    3 





    3 





    3 
    2 



    2 




    1 





    5 









    2 



    2 


    2 
    2 








    5 
    4 



    4 
    3 

    1 
    1 









    6 
    6 

    4 





    3 












    4 




    3 









    6 







   30 
















   19 






   30 



   30 







   29 
   10 



   15 
   13 




   18 











    4 



   14 





   12 


















   18 
    8 




   10 







   10 





   10 
   10 


    3 
    1 
    9 

    9 




    9 





    9 


   10 



   10 




    9 









   10 
    9 
    7 









    2 





    2 
    2 



    9 


    9 






    8 

   10 


   11 

   29 

























    3 

    2 






    1 








    1 



    1 































    1 
























































    3 





    3 



    3 






    1 

    1 
    1 

    2 












    3 
























    2 





    1 
    1 









    1 














    2 


    1 













    2 
















    3 






    3 
    3 
    1 


    2 












    2 









    2 





    2 










    2 







    2 





    2 




    2 












    2 
    2 
    2 
    1 


    2 
    2 





    1 


    1 





    1 
    1 


    1 











    1 

























    1 















    1 









    1 





    1 



































    1 
    1 







    2 





    3 


    2 




    4 

    5 

    5 



    4 







    3 






   78 


   78 

    1 
    1 

   77 






   39 


   39 
   14 
   14 
   12 



   39 






    2 


    2 


























  113 

















  110 
   17 

  111 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (C) 2007 Oracle.  All rights reserved.
 */

#include <linux/fs.h>
#include <linux/pagemap.h>
#include <linux/time.h>
#include <linux/init.h>
#include <linux/string.h>
#include <linux/backing-dev.h>
#include <linux/falloc.h>
#include <linux/filelock.h>
#include <linux/writeback.h>
#include <linux/compat.h>
#include <linux/slab.h>
#include <linux/btrfs.h>
#include <linux/uio.h>
#include <linux/iversion.h>
#include <linux/fsverity.h>
#include "ctree.h"
#include "direct-io.h"
#include "disk-io.h"
#include "transaction.h"
#include "btrfs_inode.h"
#include "tree-log.h"
#include "locking.h"
#include "qgroup.h"
#include "compression.h"
#include "delalloc-space.h"
#include "reflink.h"
#include "subpage.h"
#include "fs.h"
#include "accessors.h"
#include "extent-tree.h"
#include "file-item.h"
#include "ioctl.h"
#include "file.h"
#include "super.h"
#include "print-tree.h"

/*
 * Unlock folio after btrfs_file_write() is done with it.
 */
static void btrfs_drop_folio(struct btrfs_fs_info *fs_info, struct folio *folio,
                             u64 pos, u64 copied)
{
        u64 block_start = round_down(pos, fs_info->sectorsize);
        u64 block_len = round_up(pos + copied, fs_info->sectorsize) - block_start;

        ASSERT(block_len <= U32_MAX);
        folio_unlock(folio);
        folio_put(folio);
}

/*
 * After copy_folio_from_iter_atomic(), update the following things for delalloc:
 * - Mark newly dirtied folio as DELALLOC in the io tree.
 *   Used to advise which range is to be written back.
 * - Mark modified folio as Uptodate/Dirty
 * - Update inode size for past EOF write
 */
int btrfs_dirty_folio(struct btrfs_inode *inode, struct folio *folio, loff_t pos,
                      size_t write_bytes, struct extent_state **cached, bool noreserve)
{
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        int ret = 0;
        u64 num_bytes;
        u64 start_pos;
        u64 end_of_last_block;
        const u64 end_pos = pos + write_bytes;
        loff_t isize = i_size_read(&inode->vfs_inode);
        unsigned int extra_bits = 0;

        if (write_bytes == 0)
                return 0;

        if (noreserve)
                extra_bits |= EXTENT_NORESERVE;

        start_pos = round_down(pos, fs_info->sectorsize);
        num_bytes = round_up(end_pos - start_pos, fs_info->sectorsize);
        ASSERT(num_bytes <= U32_MAX);
        ASSERT(folio_pos(folio) <= pos && folio_next_pos(folio) >= end_pos);

        end_of_last_block = start_pos + num_bytes - 1;

        ret = btrfs_reset_extent_delalloc(inode, start_pos, end_of_last_block,
                                          extra_bits, cached);
        if (ret)
                return ret;

        btrfs_folio_clamp_set_uptodate(fs_info, folio, start_pos, num_bytes);
        btrfs_folio_clamp_set_dirty(fs_info, folio, start_pos, num_bytes);

        /*
         * we've only changed i_size in ram, and we haven't updated
         * the disk i_size.  There is no need to log the inode
         * at this time.
         */
        if (end_pos > isize)
                i_size_write(&inode->vfs_inode, end_pos);
        return 0;
}

/*
 * this is very complex, but the basic idea is to drop all extents
 * in the range start - end.  hint_block is filled in with a block number
 * that would be a good hint to the block allocator for this file.
 *
 * If an extent intersects the range but is not entirely inside the range
 * it is either truncated or split.  Anything entirely inside the range
 * is deleted from the tree.
 *
 * Note: the VFS' inode number of bytes is not updated, it's up to the caller
 * to deal with that. We set the field 'bytes_found' of the arguments structure
 * with the number of allocated bytes found in the target range, so that the
 * caller can update the inode's number of bytes in an atomic way when
 * replacing extents in a range to avoid races with stat(2).
 */
int btrfs_drop_extents(struct btrfs_trans_handle *trans,
                       struct btrfs_root *root, struct btrfs_inode *inode,
                       struct btrfs_drop_extents_args *args)
{
        struct btrfs_fs_info *fs_info = root->fs_info;
        struct extent_buffer *leaf;
        struct btrfs_file_extent_item *fi;
        struct btrfs_key key;
        struct btrfs_key new_key;
        u64 ino = btrfs_ino(inode);
        u64 search_start = args->start;
        u64 disk_bytenr = 0;
        u64 num_bytes = 0;
        u64 extent_offset = 0;
        u64 extent_end = 0;
        u64 last_end = args->start;
        int del_nr = 0;
        int del_slot = 0;
        int extent_type;
        int recow;
        int ret;
        int modify_tree = -1;
        int update_refs;
        bool found = false;
        struct btrfs_path *path = args->path;

        args->bytes_found = 0;
        args->extent_inserted = false;

        /* Must always have a path if ->replace_extent is true */
        ASSERT(!(args->replace_extent && !args->path));

        if (!path) {
                path = btrfs_alloc_path();
                if (!path) {
                        ret = -ENOMEM;
                        goto out;
                }
        }

        if (args->drop_cache)
                btrfs_drop_extent_map_range(inode, args->start, args->end - 1, false);

        if (data_race(args->start >= inode->disk_i_size) && !args->replace_extent)
                modify_tree = 0;

        update_refs = (btrfs_root_id(root) != BTRFS_TREE_LOG_OBJECTID);
        while (1) {
                recow = 0;
                ret = btrfs_lookup_file_extent(trans, root, path, ino,
                                               search_start, modify_tree);
                if (ret < 0)
                        break;
                if (ret > 0 && path->slots[0] > 0 && search_start == args->start) {
                        leaf = path->nodes[0];
                        btrfs_item_key_to_cpu(leaf, &key, path->slots[0] - 1);
                        if (key.objectid == ino &&
                            key.type == BTRFS_EXTENT_DATA_KEY)
                                path->slots[0]--;
                }
                ret = 0;
next_slot:
                leaf = path->nodes[0];
                if (path->slots[0] >= btrfs_header_nritems(leaf)) {
                        if (WARN_ON(del_nr > 0)) {
                                btrfs_print_leaf(leaf);
                                ret = -EINVAL;
                                break;
                        }
                        ret = btrfs_next_leaf(root, path);
                        if (ret < 0)
                                break;
                        if (ret > 0) {
                                ret = 0;
                                break;
                        }
                        leaf = path->nodes[0];
                        recow = 1;
                }

                btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);

                if (key.objectid > ino)
                        break;
                if (WARN_ON_ONCE(key.objectid < ino) ||
                    key.type < BTRFS_EXTENT_DATA_KEY) {
                        ASSERT(del_nr == 0);
                        path->slots[0]++;
                        goto next_slot;
                }
                if (key.type > BTRFS_EXTENT_DATA_KEY || key.offset >= args->end)
                        break;

                fi = btrfs_item_ptr(leaf, path->slots[0],
                                    struct btrfs_file_extent_item);
                extent_type = btrfs_file_extent_type(leaf, fi);

                if (extent_type == BTRFS_FILE_EXTENT_REG ||
                    extent_type == BTRFS_FILE_EXTENT_PREALLOC) {
                        disk_bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
                        num_bytes = btrfs_file_extent_disk_num_bytes(leaf, fi);
                        extent_offset = btrfs_file_extent_offset(leaf, fi);
                        extent_end = key.offset +
                                btrfs_file_extent_num_bytes(leaf, fi);
                } else if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
                        extent_end = key.offset +
                                btrfs_file_extent_ram_bytes(leaf, fi);
                } else {
                        /* can't happen */
                        BUG();
                }

                /*
                 * Don't skip extent items representing 0 byte lengths. They
                 * used to be created (bug) if while punching holes we hit
                 * -ENOSPC condition. So if we find one here, just ensure we
                 * delete it, otherwise we would insert a new file extent item
                 * with the same key (offset) as that 0 bytes length file
                 * extent item in the call to setup_items_for_insert() later
                 * in this function.
                 */
                if (extent_end == key.offset && extent_end >= search_start) {
                        last_end = extent_end;
                        goto delete_extent_item;
                }

                if (extent_end <= search_start) {
                        path->slots[0]++;
                        goto next_slot;
                }

                found = true;
                search_start = max(key.offset, args->start);
                if (recow || !modify_tree) {
                        modify_tree = -1;
                        btrfs_release_path(path);
                        continue;
                }

                /*
                 *     | - range to drop - |
                 *  | -------- extent -------- |
                 */
                if (args->start > key.offset && args->end < extent_end) {
                        if (WARN_ON(del_nr > 0)) {
                                btrfs_print_leaf(leaf);
                                ret = -EINVAL;
                                break;
                        }
                        if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
                                ret = -EOPNOTSUPP;
                                break;
                        }

                        memcpy(&new_key, &key, sizeof(new_key));
                        new_key.offset = args->start;
                        ret = btrfs_duplicate_item(trans, root, path,
                                                   &new_key);
                        if (ret == -EAGAIN) {
                                btrfs_release_path(path);
                                continue;
                        }
                        if (ret < 0)
                                break;

                        leaf = path->nodes[0];
                        fi = btrfs_item_ptr(leaf, path->slots[0] - 1,
                                            struct btrfs_file_extent_item);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        args->start - key.offset);

                        fi = btrfs_item_ptr(leaf, path->slots[0],
                                            struct btrfs_file_extent_item);

                        extent_offset += args->start - key.offset;
                        btrfs_set_file_extent_offset(leaf, fi, extent_offset);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        extent_end - args->start);

                        if (update_refs && disk_bytenr > 0) {
                                struct btrfs_ref ref = {
                                        .action = BTRFS_ADD_DELAYED_REF,
                                        .bytenr = disk_bytenr,
                                        .num_bytes = num_bytes,
                                        .parent = 0,
                                        .owning_root = btrfs_root_id(root),
                                        .ref_root = btrfs_root_id(root),
                                };
                                btrfs_init_data_ref(&ref, new_key.objectid,
                                                    args->start - extent_offset,
                                                    0, false);
                                ret = btrfs_inc_extent_ref(trans, &ref);
                                if (unlikely(ret)) {
                                        btrfs_abort_transaction(trans, ret);
                                        break;
                                }
                        }
                        key.offset = args->start;
                }
                /*
                 * From here on out we will have actually dropped something, so
                 * last_end can be updated.
                 */
                last_end = extent_end;

                /*
                 *  | ---- range to drop ----- |
                 *      | -------- extent -------- |
                 */
                if (args->start <= key.offset && args->end < extent_end) {
                        if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
                                ret = -EOPNOTSUPP;
                                break;
                        }

                        memcpy(&new_key, &key, sizeof(new_key));
                        new_key.offset = args->end;
                        btrfs_set_item_key_safe(trans, path, &new_key);

                        extent_offset += args->end - key.offset;
                        btrfs_set_file_extent_offset(leaf, fi, extent_offset);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        extent_end - args->end);
                        if (update_refs && disk_bytenr > 0)
                                args->bytes_found += args->end - key.offset;
                        break;
                }

                search_start = extent_end;
                /*
                 *       | ---- range to drop ----- |
                 *  | -------- extent -------- |
                 */
                if (args->start > key.offset && args->end >= extent_end) {
                        if (WARN_ON(del_nr > 0)) {
                                btrfs_print_leaf(leaf);
                                ret = -EINVAL;
                                break;
                        }
                        if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
                                ret = -EOPNOTSUPP;
                                break;
                        }

                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        args->start - key.offset);
                        if (update_refs && disk_bytenr > 0)
                                args->bytes_found += extent_end - args->start;
                        if (args->end == extent_end)
                                break;

                        path->slots[0]++;
                        goto next_slot;
                }

                /*
                 *  | ---- range to drop ----- |
                 *    | ------ extent ------ |
                 */
                if (args->start <= key.offset && args->end >= extent_end) {
delete_extent_item:
                        if (del_nr == 0) {
                                del_slot = path->slots[0];
                                del_nr = 1;
                        } else {
                                if (WARN_ON(del_slot + del_nr != path->slots[0])) {
                                        btrfs_print_leaf(leaf);
                                        ret = -EINVAL;
                                        break;
                                }
                                del_nr++;
                        }

                        if (update_refs &&
                            extent_type == BTRFS_FILE_EXTENT_INLINE) {
                                args->bytes_found += extent_end - key.offset;
                                extent_end = ALIGN(extent_end,
                                                   fs_info->sectorsize);
                        } else if (update_refs && disk_bytenr > 0) {
                                struct btrfs_ref ref = {
                                        .action = BTRFS_DROP_DELAYED_REF,
                                        .bytenr = disk_bytenr,
                                        .num_bytes = num_bytes,
                                        .parent = 0,
                                        .owning_root = btrfs_root_id(root),
                                        .ref_root = btrfs_root_id(root),
                                };
                                btrfs_init_data_ref(&ref, key.objectid,
                                                    key.offset - extent_offset,
                                                    0, false);
                                ret = btrfs_free_extent(trans, &ref);
                                if (unlikely(ret)) {
                                        btrfs_abort_transaction(trans, ret);
                                        break;
                                }
                                args->bytes_found += extent_end - key.offset;
                        }

                        if (args->end == extent_end)
                                break;

                        if (path->slots[0] + 1 < btrfs_header_nritems(leaf)) {
                                path->slots[0]++;
                                goto next_slot;
                        }

                        ret = btrfs_del_items(trans, root, path, del_slot,
                                              del_nr);
                        if (unlikely(ret)) {
                                btrfs_abort_transaction(trans, ret);
                                break;
                        }

                        del_nr = 0;
                        del_slot = 0;

                        btrfs_release_path(path);
                        continue;
                }

                BUG();
        }

        if (!ret && del_nr > 0) {
                /*
                 * Set path->slots[0] to first slot, so that after the delete
                 * if items are move off from our leaf to its immediate left or
                 * right neighbor leafs, we end up with a correct and adjusted
                 * path->slots[0] for our insertion (if args->replace_extent).
                 */
                path->slots[0] = del_slot;
                ret = btrfs_del_items(trans, root, path, del_slot, del_nr);
                if (ret)
                        btrfs_abort_transaction(trans, ret);
        }

        leaf = path->nodes[0];
        /*
         * If btrfs_del_items() was called, it might have deleted a leaf, in
         * which case it unlocked our path, so check path->locks[0] matches a
         * write lock.
         */
        if (!ret && args->replace_extent &&
            path->locks[0] == BTRFS_WRITE_LOCK &&
            btrfs_leaf_free_space(leaf) >=
            sizeof(struct btrfs_item) + args->extent_item_size) {

                key.objectid = ino;
                key.type = BTRFS_EXTENT_DATA_KEY;
                key.offset = args->start;
                if (!del_nr && path->slots[0] < btrfs_header_nritems(leaf)) {
                        struct btrfs_key slot_key;

                        btrfs_item_key_to_cpu(leaf, &slot_key, path->slots[0]);
                        if (btrfs_comp_cpu_keys(&key, &slot_key) > 0)
                                path->slots[0]++;
                }
                btrfs_setup_item_for_insert(trans, root, path, &key,
                                            args->extent_item_size);
                args->extent_inserted = true;
        }

        if (!args->path)
                btrfs_free_path(path);
        else if (!args->extent_inserted)
                btrfs_release_path(path);
out:
        args->drop_end = found ? min(args->end, last_end) : args->end;

        return ret;
}

static bool extent_mergeable(struct extent_buffer *leaf, int slot, u64 objectid,
                             u64 bytenr, u64 orig_offset, u64 *start, u64 *end)
{
        struct btrfs_file_extent_item *fi;
        struct btrfs_key key;
        u64 extent_end;

        if (slot < 0 || slot >= btrfs_header_nritems(leaf))
                return false;

        btrfs_item_key_to_cpu(leaf, &key, slot);
        if (key.objectid != objectid || key.type != BTRFS_EXTENT_DATA_KEY)
                return false;

        fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
        if (btrfs_file_extent_type(leaf, fi) != BTRFS_FILE_EXTENT_REG ||
            btrfs_file_extent_disk_bytenr(leaf, fi) != bytenr ||
            btrfs_file_extent_offset(leaf, fi) != key.offset - orig_offset ||
            btrfs_file_extent_compression(leaf, fi) ||
            btrfs_file_extent_encryption(leaf, fi) ||
            btrfs_file_extent_other_encoding(leaf, fi))
                return false;

        extent_end = key.offset + btrfs_file_extent_num_bytes(leaf, fi);
        if ((*start && *start != key.offset) || (*end && *end != extent_end))
                return false;

        *start = key.offset;
        *end = extent_end;
        return true;
}

/*
 * Mark extent in the range start - end as written.
 *
 * This changes extent type from 'pre-allocated' to 'regular'. If only
 * part of extent is marked as written, the extent will be split into
 * two or three.
 */
int btrfs_mark_extent_written(struct btrfs_trans_handle *trans,
                              struct btrfs_inode *inode, u64 start, u64 end)
{
        struct btrfs_root *root = inode->root;
        struct extent_buffer *leaf;
        BTRFS_PATH_AUTO_FREE(path);
        struct btrfs_file_extent_item *fi;
        struct btrfs_ref ref = { 0 };
        struct btrfs_key key;
        struct btrfs_key new_key;
        u64 bytenr;
        u64 num_bytes;
        u64 extent_end;
        u64 orig_offset;
        u64 other_start;
        u64 other_end;
        u64 split;
        int del_nr = 0;
        int del_slot = 0;
        int recow;
        int ret;
        u64 ino = btrfs_ino(inode);

        path = btrfs_alloc_path();
        if (!path)
                return -ENOMEM;
again:
        recow = 0;
        split = start;
        key.objectid = ino;
        key.type = BTRFS_EXTENT_DATA_KEY;
        key.offset = split;

        ret = btrfs_search_slot(trans, root, &key, path, -1, 1);
        if (ret < 0)
                return ret;
        if (ret > 0 && path->slots[0] > 0)
                path->slots[0]--;

        leaf = path->nodes[0];
        btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
        if (unlikely(key.objectid != ino || key.type != BTRFS_EXTENT_DATA_KEY)) {
                ret = -EINVAL;
                btrfs_abort_transaction(trans, ret);
                return ret;
        }
        fi = btrfs_item_ptr(leaf, path->slots[0],
                            struct btrfs_file_extent_item);
        if (unlikely(btrfs_file_extent_type(leaf, fi) != BTRFS_FILE_EXTENT_PREALLOC)) {
                ret = -EINVAL;
                btrfs_abort_transaction(trans, ret);
                return ret;
        }
        extent_end = key.offset + btrfs_file_extent_num_bytes(leaf, fi);
        if (unlikely(key.offset > start || extent_end < end)) {
                ret = -EINVAL;
                btrfs_abort_transaction(trans, ret);
                return ret;
        }

        bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
        num_bytes = btrfs_file_extent_disk_num_bytes(leaf, fi);
        orig_offset = key.offset - btrfs_file_extent_offset(leaf, fi);
        memcpy(&new_key, &key, sizeof(new_key));

        if (start == key.offset && end < extent_end) {
                other_start = 0;
                other_end = start;
                if (extent_mergeable(leaf, path->slots[0] - 1,
                                     ino, bytenr, orig_offset,
                                     &other_start, &other_end)) {
                        new_key.offset = end;
                        btrfs_set_item_key_safe(trans, path, &new_key);
                        fi = btrfs_item_ptr(leaf, path->slots[0],
                                            struct btrfs_file_extent_item);
                        btrfs_set_file_extent_generation(leaf, fi,
                                                         trans->transid);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        extent_end - end);
                        btrfs_set_file_extent_offset(leaf, fi,
                                                     end - orig_offset);
                        fi = btrfs_item_ptr(leaf, path->slots[0] - 1,
                                            struct btrfs_file_extent_item);
                        btrfs_set_file_extent_generation(leaf, fi,
                                                         trans->transid);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        end - other_start);
                        goto mark_dirty;
                }
        }

        if (start > key.offset && end == extent_end) {
                other_start = end;
                other_end = 0;
                if (extent_mergeable(leaf, path->slots[0] + 1,
                                     ino, bytenr, orig_offset,
                                     &other_start, &other_end)) {
                        fi = btrfs_item_ptr(leaf, path->slots[0],
                                            struct btrfs_file_extent_item);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        start - key.offset);
                        btrfs_set_file_extent_generation(leaf, fi,
                                                         trans->transid);
                        path->slots[0]++;
                        new_key.offset = start;
                        btrfs_set_item_key_safe(trans, path, &new_key);

                        fi = btrfs_item_ptr(leaf, path->slots[0],
                                            struct btrfs_file_extent_item);
                        btrfs_set_file_extent_generation(leaf, fi,
                                                         trans->transid);
                        btrfs_set_file_extent_num_bytes(leaf, fi,
                                                        other_end - start);
                        btrfs_set_file_extent_offset(leaf, fi,
                                                     start - orig_offset);
                        goto mark_dirty;
                }
        }

        while (start > key.offset || end < extent_end) {
                if (key.offset == start)
                        split = end;

                new_key.offset = split;
                ret = btrfs_duplicate_item(trans, root, path, &new_key);
                if (ret == -EAGAIN) {
                        btrfs_release_path(path);
                        goto again;
                }
                if (unlikely(ret < 0)) {
                        btrfs_abort_transaction(trans, ret);
                        return ret;
                }

                leaf = path->nodes[0];
                fi = btrfs_item_ptr(leaf, path->slots[0] - 1,
                                    struct btrfs_file_extent_item);
                btrfs_set_file_extent_generation(leaf, fi, trans->transid);
                btrfs_set_file_extent_num_bytes(leaf, fi,
                                                split - key.offset);

                fi = btrfs_item_ptr(leaf, path->slots[0],
                                    struct btrfs_file_extent_item);

                btrfs_set_file_extent_generation(leaf, fi, trans->transid);
                btrfs_set_file_extent_offset(leaf, fi, split - orig_offset);
                btrfs_set_file_extent_num_bytes(leaf, fi,
                                                extent_end - split);

                ref.action = BTRFS_ADD_DELAYED_REF;
                ref.bytenr = bytenr;
                ref.num_bytes = num_bytes;
                ref.parent = 0;
                ref.owning_root = btrfs_root_id(root);
                ref.ref_root = btrfs_root_id(root);
                btrfs_init_data_ref(&ref, ino, orig_offset, 0, false);
                ret = btrfs_inc_extent_ref(trans, &ref);
                if (unlikely(ret)) {
                        btrfs_abort_transaction(trans, ret);
                        return ret;
                }

                if (split == start) {
                        key.offset = start;
                } else {
                        if (unlikely(start != key.offset)) {
                                ret = -EINVAL;
                                btrfs_abort_transaction(trans, ret);
                                return ret;
                        }
                        path->slots[0]--;
                        extent_end = end;
                }
                recow = 1;
        }

        other_start = end;
        other_end = 0;

        ref.action = BTRFS_DROP_DELAYED_REF;
        ref.bytenr = bytenr;
        ref.num_bytes = num_bytes;
        ref.parent = 0;
        ref.owning_root = btrfs_root_id(root);
        ref.ref_root = btrfs_root_id(root);
        btrfs_init_data_ref(&ref, ino, orig_offset, 0, false);
        if (extent_mergeable(leaf, path->slots[0] + 1,
                             ino, bytenr, orig_offset,
                             &other_start, &other_end)) {
                if (recow) {
                        btrfs_release_path(path);
                        goto again;
                }
                extent_end = other_end;
                del_slot = path->slots[0] + 1;
                del_nr++;
                ret = btrfs_free_extent(trans, &ref);
                if (unlikely(ret)) {
                        btrfs_abort_transaction(trans, ret);
                        return ret;
                }
        }
        other_start = 0;
        other_end = start;
        if (extent_mergeable(leaf, path->slots[0] - 1,
                             ino, bytenr, orig_offset,
                             &other_start, &other_end)) {
                if (recow) {
                        btrfs_release_path(path);
                        goto again;
                }
                key.offset = other_start;
                del_slot = path->slots[0];
                del_nr++;
                ret = btrfs_free_extent(trans, &ref);
                if (unlikely(ret)) {
                        btrfs_abort_transaction(trans, ret);
                        return ret;
                }
        }
        if (del_nr == 0) {
                fi = btrfs_item_ptr(leaf, path->slots[0],
                           struct btrfs_file_extent_item);
                btrfs_set_file_extent_type(leaf, fi,
                                           BTRFS_FILE_EXTENT_REG);
                btrfs_set_file_extent_generation(leaf, fi, trans->transid);
        } else {
                fi = btrfs_item_ptr(leaf, del_slot - 1,
                           struct btrfs_file_extent_item);
                btrfs_set_file_extent_type(leaf, fi,
                                           BTRFS_FILE_EXTENT_REG);
                btrfs_set_file_extent_generation(leaf, fi, trans->transid);
                btrfs_set_file_extent_num_bytes(leaf, fi,
                                                extent_end - key.offset);

                ret = btrfs_del_items(trans, root, path, del_slot, del_nr);
                if (unlikely(ret < 0)) {
                        btrfs_abort_transaction(trans, ret);
                        return ret;
                }
        }

mark_dirty:
        ret = btrfs_inode_set_file_extent_range(inode, start, end - start);
        if (ret)
                btrfs_abort_transaction(trans, ret);

        return ret;
}

/*
 * On error return an unlocked folio and the error value
 * On success return a locked folio and 0
 */
static int prepare_uptodate_folio(struct inode *inode, struct folio *folio, u64 pos,
                                  u64 len)
{
        u64 clamp_start = max_t(u64, pos, folio_pos(folio));
        u64 clamp_end = min_t(u64, pos + len, folio_next_pos(folio));
        const u32 blocksize = inode_to_fs_info(inode)->sectorsize;
        int ret = 0;

        if (folio_test_uptodate(folio))
                return 0;

        if (IS_ALIGNED(clamp_start, blocksize) &&
            IS_ALIGNED(clamp_end, blocksize))
                return 0;

        ret = btrfs_read_folio(NULL, folio);
        if (ret)
                return ret;
        folio_lock(folio);
        if (unlikely(!folio_test_uptodate(folio))) {
                folio_unlock(folio);
                return -EIO;
        }

        /*
         * Since btrfs_read_folio() will unlock the folio before it returns,
         * there is a window where btrfs_release_folio() can be called to
         * release the page.  Here we check both inode mapping and page
         * private to make sure the page was not released.
         *
         * The private flag check is essential for subpage as we need to store
         * extra bitmap using folio private.
         */
        if (folio->mapping != inode->i_mapping || !folio_test_private(folio)) {
                folio_unlock(folio);
                return -EAGAIN;
        }
        return 0;
}

static gfp_t get_prepare_gfp_flags(struct inode *inode, bool nowait)
{
        gfp_t gfp;

        gfp = btrfs_alloc_write_mask(inode->i_mapping);
        if (nowait) {
                gfp &= ~__GFP_DIRECT_RECLAIM;
                gfp |= GFP_NOWAIT;
        }

        return gfp;
}

/*
 * Get folio into the page cache and lock it.
 */
static noinline int prepare_one_folio(struct inode *inode, struct folio **folio_ret,
                                      loff_t pos, size_t write_bytes,
                                      bool nowait)
{
        const pgoff_t index = pos >> PAGE_SHIFT;
        gfp_t mask = get_prepare_gfp_flags(inode, nowait);
        fgf_t fgp_flags = (nowait ? FGP_WRITEBEGIN | FGP_NOWAIT : FGP_WRITEBEGIN) |
                          fgf_set_order(write_bytes);
        struct folio *folio;
        int ret;

again:
        folio = __filemap_get_folio(inode->i_mapping, index, fgp_flags, mask);
        if (IS_ERR(folio))
                return PTR_ERR(folio);

        ret = set_folio_extent_mapped(folio);
        if (ret < 0) {
                folio_unlock(folio);
                folio_put(folio);
                return ret;
        }
        ret = prepare_uptodate_folio(inode, folio, pos, write_bytes);
        if (ret) {
                /* The folio is already unlocked. */
                folio_put(folio);
                if (!nowait && ret == -EAGAIN)
                        goto again;
                return ret;
        }
        *folio_ret = folio;
        return 0;
}

/*
 * Locks the extent and properly waits for data=ordered extents to finish
 * before allowing the folios to be modified if need.
 *
 * Return:
 * 1 - the extent is locked
 * 0 - the extent is not locked, and everything is OK
 * -EAGAIN - need to prepare the folios again
 */
static noinline int
lock_and_cleanup_extent_if_need(struct btrfs_inode *inode, struct folio *folio,
                                loff_t pos, size_t write_bytes,
                                u64 *lockstart, u64 *lockend, bool nowait,
                                struct extent_state **cached_state)
{
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        u64 start_pos;
        u64 last_pos;
        int ret = 0;

        start_pos = round_down(pos, fs_info->sectorsize);
        last_pos = round_up(pos + write_bytes, fs_info->sectorsize) - 1;

        if (start_pos < inode->vfs_inode.i_size) {
                struct btrfs_ordered_extent *ordered;

                if (nowait) {
                        if (!btrfs_try_lock_extent(&inode->io_tree, start_pos,
                                                   last_pos, cached_state)) {
                                folio_unlock(folio);
                                folio_put(folio);
                                return -EAGAIN;
                        }
                } else {
                        btrfs_lock_extent(&inode->io_tree, start_pos, last_pos,
                                          cached_state);
                }

                ordered = btrfs_lookup_ordered_range(inode, start_pos,
                                                     last_pos - start_pos + 1);
                if (ordered &&
                    ordered->file_offset + ordered->num_bytes > start_pos &&
                    ordered->file_offset <= last_pos) {
                        btrfs_unlock_extent(&inode->io_tree, start_pos, last_pos,
                                            cached_state);
                        folio_unlock(folio);
                        folio_put(folio);
                        btrfs_start_ordered_extent(ordered);
                        btrfs_put_ordered_extent(ordered);
                        return -EAGAIN;
                }
                if (ordered)
                        btrfs_put_ordered_extent(ordered);

                *lockstart = start_pos;
                *lockend = last_pos;
                ret = 1;
        }

        /*
         * We should be called after prepare_one_folio() which should have locked
         * all pages in the range.
         */
        WARN_ON(!folio_test_locked(folio));

        return ret;
}

/*
 * Check if we can do nocow write into the range [@pos, @pos + @write_bytes)
 *
 * @pos:         File offset.
 * @write_bytes: The length to write, will be updated to the nocow writeable
 *               range.
 * @nowait:      Indicate if we can block or not (non-blocking IO context).
 *
 * This function will flush ordered extents in the range to ensure proper
 * nocow checks.
 *
 * Return:
 * > 0          If we can nocow, and updates @write_bytes.
 *  0           If we can't do a nocow write.
 * -EAGAIN      If we can't do a nocow write because snapshotting of the inode's
 *              root is in progress or because we are in a non-blocking IO
 *              context and need to block (@nowait is true).
 * < 0          If an error happened.
 *
 * NOTE: Callers need to call btrfs_check_nocow_unlock() if we return > 0.
 */
int btrfs_check_nocow_lock(struct btrfs_inode *inode, loff_t pos,
                           size_t *write_bytes, bool nowait)
{
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        struct btrfs_root *root = inode->root;
        struct extent_state *cached_state = NULL;
        u64 lockstart, lockend;
        u64 cur_offset;
        int ret = 0;

        if (!(inode->flags & (BTRFS_INODE_NODATACOW | BTRFS_INODE_PREALLOC)))
                return 0;

        if (!btrfs_drew_try_write_lock(&root->snapshot_lock))
                return -EAGAIN;

        lockstart = round_down(pos, fs_info->sectorsize);
        lockend = round_up(pos + *write_bytes,
                           fs_info->sectorsize) - 1;

        if (nowait) {
                if (!btrfs_try_lock_ordered_range(inode, lockstart, lockend,
                                                  &cached_state)) {
                        btrfs_drew_write_unlock(&root->snapshot_lock);
                        return -EAGAIN;
                }
        } else {
                btrfs_lock_and_flush_ordered_range(inode, lockstart, lockend,
                                                   &cached_state);
        }

        cur_offset = lockstart;
        while (cur_offset < lockend) {
                u64 num_bytes = lockend - cur_offset + 1;

                ret = can_nocow_extent(inode, cur_offset, &num_bytes, NULL, nowait);
                if (ret <= 0) {
                        /*
                         * If cur_offset == lockstart it means we haven't found
                         * any extent against which we can NOCOW, so unlock the
                         * snapshot lock.
                         */
                        if (cur_offset == lockstart)
                                btrfs_drew_write_unlock(&root->snapshot_lock);
                        break;
                }
                cur_offset += num_bytes;
        }

        btrfs_unlock_extent(&inode->io_tree, lockstart, lockend, &cached_state);

        /*
         * cur_offset > lockstart means there's at least a partial range we can
         * NOCOW, and that range can cover one or more extents.
         */
        if (cur_offset > lockstart) {
                *write_bytes = min_t(size_t, *write_bytes, cur_offset - pos);
                return 1;
        }

        return ret;
}

void btrfs_check_nocow_unlock(struct btrfs_inode *inode)
{
        btrfs_drew_write_unlock(&inode->root->snapshot_lock);
}

int btrfs_write_check(struct kiocb *iocb, size_t count)
{
        struct file *file = iocb->ki_filp;
        struct inode *inode = file_inode(file);
        struct btrfs_fs_info *fs_info = inode_to_fs_info(inode);
        loff_t pos = iocb->ki_pos;
        int ret;
        loff_t oldsize;

        /*
         * Quickly bail out on NOWAIT writes if we don't have the nodatacow or
         * prealloc flags, as without those flags we always have to COW. We will
         * later check if we can really COW into the target range (using
         * can_nocow_extent() at btrfs_get_blocks_direct_write()).
         */
        if ((iocb->ki_flags & IOCB_NOWAIT) &&
            !(BTRFS_I(inode)->flags & (BTRFS_INODE_NODATACOW | BTRFS_INODE_PREALLOC)))
                return -EAGAIN;

        ret = file_remove_privs(file);
        if (ret)
                return ret;

        /*
         * We reserve space for updating the inode when we reserve space for the
         * extent we are going to write, so we will enospc out there.  We don't
         * need to start yet another transaction to update the inode as we will
         * update the inode when we finish writing whatever data we write.
         */
        if (!IS_NOCMTIME(inode)) {
                inode_set_mtime_to_ts(inode, inode_set_ctime_current(inode));
                inode_inc_iversion(inode);
        }

        oldsize = i_size_read(inode);
        if (pos > oldsize) {
                /* Expand hole size to cover write data, preventing empty gap */
                loff_t end_pos = round_up(pos + count, fs_info->sectorsize);

                ret = btrfs_cont_expand(BTRFS_I(inode), oldsize, end_pos);
                if (ret)
                        return ret;
        }

        return 0;
}

static void release_space(struct btrfs_inode *inode, struct extent_changeset *data_reserved,
                          u64 start, u64 len, bool only_release_metadata)
{
        if (len == 0)
                return;

        if (only_release_metadata) {
                btrfs_check_nocow_unlock(inode);
                btrfs_delalloc_release_metadata(inode, len, true);
        } else {
                const struct btrfs_fs_info *fs_info = inode->root->fs_info;

                btrfs_delalloc_release_space(inode, data_reserved,
                                             round_down(start, fs_info->sectorsize),
                                             len, true);
        }
}

/*
 * Reserve data and metadata space for this buffered write range.
 *
 * Return >0 for the number of bytes reserved, which is always block aligned.
 * Return <0 for error.
 */
static ssize_t reserve_space(struct btrfs_inode *inode,
                             struct extent_changeset **data_reserved,
                             u64 start, size_t *len, bool nowait,
                             bool *only_release_metadata)
{
        const struct btrfs_fs_info *fs_info = inode->root->fs_info;
        const unsigned int block_offset = (start & (fs_info->sectorsize - 1));
        size_t reserve_bytes;
        int ret;

        ret = btrfs_check_data_free_space(inode, data_reserved, start, *len, nowait);
        if (ret < 0) {
                int can_nocow;

                if (nowait && (ret == -ENOSPC || ret == -EAGAIN))
                        return -EAGAIN;

                /*
                 * If we don't have to COW at the offset, reserve metadata only.
                 * write_bytes may get smaller than requested here.
                 */
                can_nocow = btrfs_check_nocow_lock(inode, start, len, nowait);
                if (can_nocow < 0)
                        ret = can_nocow;
                if (can_nocow > 0)
                        ret = 0;
                if (ret)
                        return ret;
                *only_release_metadata = true;
        }

        reserve_bytes = round_up(*len + block_offset, fs_info->sectorsize);
        WARN_ON(reserve_bytes == 0);
        ret = btrfs_delalloc_reserve_metadata(inode, reserve_bytes,
                                              reserve_bytes, nowait);
        if (ret) {
                if (!*only_release_metadata)
                        btrfs_free_reserved_data_space(inode, *data_reserved,
                                                       start, *len);
                else
                        btrfs_check_nocow_unlock(inode);

                if (nowait && ret == -ENOSPC)
                        ret = -EAGAIN;
                return ret;
        }
        return reserve_bytes;
}

/* Shrink the reserved data and metadata space from @reserved_len to @new_len. */
static void shrink_reserved_space(struct btrfs_inode *inode,
                                  struct extent_changeset *data_reserved,
                                  u64 reserved_start, u64 reserved_len,
                                  u64 new_len, bool only_release_metadata)
{
        const u64 diff = reserved_len - new_len;

        ASSERT(new_len <= reserved_len);
        btrfs_delalloc_shrink_extents(inode, reserved_len, new_len);
        if (only_release_metadata)
                btrfs_delalloc_release_metadata(inode, diff, true);
        else
                btrfs_delalloc_release_space(inode, data_reserved,
                                             reserved_start + new_len, diff, true);
}

/* Calculate the maximum amount of bytes we can write into one folio. */
static size_t calc_write_bytes(const struct btrfs_inode *inode,
                               const struct iov_iter *iter, u64 start)
{
        const size_t max_folio_size = mapping_max_folio_size(inode->vfs_inode.i_mapping);

        return min(max_folio_size - (start & (max_folio_size - 1)),
                   iov_iter_count(iter));
}

/*
 * Do the heavy-lifting work to copy one range into one folio of the page cache.
 *
 * Return > 0 in case we copied all bytes or just some of them.
 * Return 0 if no bytes were copied, in which case the caller should retry.
 * Return <0 on error.
 */
static int copy_one_range(struct btrfs_inode *inode, struct iov_iter *iter,
                          struct extent_changeset **data_reserved, u64 start,
                          bool nowait)
{
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        struct extent_state *cached_state = NULL;
        size_t write_bytes = calc_write_bytes(inode, iter, start);
        size_t copied;
        const u64 reserved_start = round_down(start, fs_info->sectorsize);
        u64 reserved_len;
        struct folio *folio = NULL;
        int extents_locked;
        u64 lockstart;
        u64 lockend;
        bool only_release_metadata = false;
        const unsigned int bdp_flags = (nowait ? BDP_ASYNC : 0);
        int ret;

        /*
         * Fault all pages before locking them in prepare_one_folio() to avoid
         * recursive lock.
         */
        if (unlikely(fault_in_iov_iter_readable(iter, write_bytes)))
                return -EFAULT;
        extent_changeset_release(*data_reserved);
        ret = reserve_space(inode, data_reserved, start, &write_bytes, nowait,
                            &only_release_metadata);
        if (ret < 0)
                return ret;
        reserved_len = ret;
        /* Write range must be inside the reserved range. */
        ASSERT(reserved_start <= start, "reserved_start=%llu start=%llu",
               reserved_start, start);
        ASSERT(start + write_bytes <= reserved_start + reserved_len,
               "start=%llu write_bytes=%zu reserved_start=%llu reserved_len=%llu",
               start, write_bytes, reserved_start, reserved_len);

again:
        ret = balance_dirty_pages_ratelimited_flags(inode->vfs_inode.i_mapping,
                                                    bdp_flags);
        if (ret) {
                btrfs_delalloc_release_extents(inode, reserved_len);
                release_space(inode, *data_reserved, reserved_start, reserved_len,
                              only_release_metadata);
                return ret;
        }

        ret = prepare_one_folio(&inode->vfs_inode, &folio, start, write_bytes, false);
        if (ret) {
                btrfs_delalloc_release_extents(inode, reserved_len);
                release_space(inode, *data_reserved, reserved_start, reserved_len,
                              only_release_metadata);
                return ret;
        }

        /*
         * The reserved range goes beyond the current folio, shrink the reserved
         * space to the folio boundary.
         */
        if (reserved_start + reserved_len > folio_next_pos(folio)) {
                const u64 last_block = folio_next_pos(folio);

                shrink_reserved_space(inode, *data_reserved, reserved_start,
                                      reserved_len, last_block - reserved_start,
                                      only_release_metadata);
                write_bytes = last_block - start;
                reserved_len = last_block - reserved_start;
        }

        extents_locked = lock_and_cleanup_extent_if_need(inode, folio, start,
                                                         write_bytes, &lockstart,
                                                         &lockend, nowait,
                                                         &cached_state);
        if (extents_locked < 0) {
                if (!nowait && extents_locked == -EAGAIN)
                        goto again;

                btrfs_delalloc_release_extents(inode, reserved_len);
                release_space(inode, *data_reserved, reserved_start, reserved_len,
                              only_release_metadata);
                return extents_locked;
        }

        copied = copy_folio_from_iter_atomic(folio, offset_in_folio(folio, start),
                                             write_bytes, iter);
        flush_dcache_folio(folio);

        if (unlikely(copied < write_bytes)) {
                u64 last_block;

                /*
                 * The original write range doesn't need an uptodate folio as
                 * the range is block aligned. But now a short copy happened.
                 * We cannot handle it without an uptodate folio.
                 *
                 * So just revert the range and we will retry.
                 */
                if (!folio_test_uptodate(folio)) {
                        iov_iter_revert(iter, copied);
                        copied = 0;
                }

                /* No copied bytes, unlock, release reserved space and exit. */
                if (copied == 0) {
                        if (extents_locked)
                                btrfs_unlock_extent(&inode->io_tree, lockstart, lockend,
                                                    &cached_state);
                        else
                                btrfs_free_extent_state(cached_state);
                        btrfs_delalloc_release_extents(inode, reserved_len);
                        release_space(inode, *data_reserved, reserved_start, reserved_len,
                                      only_release_metadata);
                        btrfs_drop_folio(fs_info, folio, start, copied);
                        return 0;
                }

                /* Release the reserved space beyond the last block. */
                last_block = round_up(start + copied, fs_info->sectorsize);

                shrink_reserved_space(inode, *data_reserved, reserved_start,
                                      reserved_len, last_block - reserved_start,
                                      only_release_metadata);
                reserved_len = last_block - reserved_start;
        }

        ret = btrfs_dirty_folio(inode, folio, start, copied, &cached_state,
                                only_release_metadata);
        /*
         * If we have not locked the extent range, because the range's start
         * offset is >= i_size, we might still have a non-NULL cached extent
         * state, acquired while marking the extent range as delalloc through
         * btrfs_dirty_page(). Therefore free any possible cached extent state
         * to avoid a memory leak.
         */
        if (extents_locked)
                btrfs_unlock_extent(&inode->io_tree, lockstart, lockend, &cached_state);
        else
                btrfs_free_extent_state(cached_state);

        btrfs_delalloc_release_extents(inode, reserved_len);
        if (ret) {
                btrfs_drop_folio(fs_info, folio, start, copied);
                release_space(inode, *data_reserved, reserved_start, reserved_len,
                              only_release_metadata);
                return ret;
        }
        if (only_release_metadata)
                btrfs_check_nocow_unlock(inode);

        btrfs_drop_folio(fs_info, folio, start, copied);
        return copied;
}

ssize_t btrfs_buffered_write(struct kiocb *iocb, struct iov_iter *iter)
{
        struct file *file = iocb->ki_filp;
        loff_t pos;
        struct inode *inode = file_inode(file);
        struct extent_changeset *data_reserved = NULL;
        size_t num_written = 0;
        ssize_t ret;
        loff_t old_isize;
        unsigned int ilock_flags = 0;
        const bool nowait = (iocb->ki_flags & IOCB_NOWAIT);

        if (nowait)
                ilock_flags |= BTRFS_ILOCK_TRY;

        ret = btrfs_inode_lock(BTRFS_I(inode), ilock_flags);
        if (ret < 0)
                return ret;

        /*
         * We can only trust the isize with inode lock held, or it can race with
         * other buffered writes and cause incorrect call of
         * pagecache_isize_extended() to overwrite existing data.
         */
        old_isize = i_size_read(inode);

        ret = generic_write_checks(iocb, iter);
        if (ret <= 0)
                goto out;

        ret = btrfs_write_check(iocb, ret);
        if (ret < 0)
                goto out;

        pos = iocb->ki_pos;
        while (iov_iter_count(iter) > 0) {
                ret = copy_one_range(BTRFS_I(inode), iter, &data_reserved, pos, nowait);
                if (ret < 0)
                        break;
                pos += ret;
                num_written += ret;
                cond_resched();
        }

        extent_changeset_free(data_reserved);
        if (num_written > 0) {
                pagecache_isize_extended(inode, old_isize, iocb->ki_pos);
                iocb->ki_pos += num_written;
        }
out:
        btrfs_inode_unlock(BTRFS_I(inode), ilock_flags);
        return num_written ? num_written : ret;
}

static ssize_t btrfs_encoded_write(struct kiocb *iocb, struct iov_iter *from,
                        const struct btrfs_ioctl_encoded_io_args *encoded)
{
        struct file *file = iocb->ki_filp;
        struct inode *inode = file_inode(file);
        loff_t count;
        ssize_t ret;

        btrfs_inode_lock(BTRFS_I(inode), 0);
        count = encoded->len;
        ret = generic_write_checks_count(iocb, &count);
        if (ret == 0 && count != encoded->len) {
                /*
                 * The write got truncated by generic_write_checks_count(). We
                 * can't do a partial encoded write.
                 */
                ret = -EFBIG;
        }
        if (ret || encoded->len == 0)
                goto out;

        ret = btrfs_write_check(iocb, encoded->len);
        if (ret < 0)
                goto out;

        ret = btrfs_do_encoded_write(iocb, from, encoded);
out:
        btrfs_inode_unlock(BTRFS_I(inode), 0);
        return ret;
}

ssize_t btrfs_do_write_iter(struct kiocb *iocb, struct iov_iter *from,
                            const struct btrfs_ioctl_encoded_io_args *encoded)
{
        struct file *file = iocb->ki_filp;
        struct btrfs_inode *inode = BTRFS_I(file_inode(file));
        ssize_t num_written, num_sync;

        if (btrfs_is_shutdown(inode->root->fs_info))
                return -EIO;
        /*
         * If the fs flips readonly due to some impossible error, although we
         * have opened a file as writable, we have to stop this write operation
         * to ensure consistency.
         */
        if (unlikely(BTRFS_FS_ERROR(inode->root->fs_info)))
                return -EROFS;

        if (encoded && (iocb->ki_flags & IOCB_NOWAIT))
                return -EOPNOTSUPP;

        if (encoded) {
                num_written = btrfs_encoded_write(iocb, from, encoded);
                num_sync = encoded->len;
        } else if (iocb->ki_flags & IOCB_DIRECT) {
                num_written = btrfs_direct_write(iocb, from);
                num_sync = num_written;
        } else {
                num_written = btrfs_buffered_write(iocb, from);
                num_sync = num_written;
        }

        btrfs_set_inode_last_sub_trans(inode);

        if (num_sync > 0) {
                num_sync = generic_write_sync(iocb, num_sync);
                if (num_sync < 0)
                        num_written = num_sync;
        }

        return num_written;
}

static ssize_t btrfs_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
{
        return btrfs_do_write_iter(iocb, from, NULL);
}

int btrfs_release_file(struct inode *inode, struct file *filp)
{
        struct btrfs_file_private *private = filp->private_data;

        if (private) {
                kfree(private->filldir_buf);
                btrfs_free_extent_state(private->llseek_cached_state);
                kfree(private);
                filp->private_data = NULL;
        }

        /*
         * Set by setattr when we are about to truncate a file from a non-zero
         * size to a zero size.  This tries to flush down new bytes that may
         * have been written if the application were using truncate to replace
         * a file in place.
         */
        if (test_and_clear_bit(BTRFS_INODE_FLUSH_ON_CLOSE,
                               &BTRFS_I(inode)->runtime_flags))
                        filemap_flush(inode->i_mapping);
        return 0;
}

static int start_ordered_ops(struct btrfs_inode *inode, loff_t start, loff_t end)
{
        int ret;
        struct blk_plug plug;

        /*
         * This is only called in fsync, which would do synchronous writes, so
         * a plug can merge adjacent IOs as much as possible.  Esp. in case of
         * multiple disks using raid profile, a large IO can be split to
         * several segments of stripe length (currently 64K).
         */
        blk_start_plug(&plug);
        ret = btrfs_fdatawrite_range(inode, start, end);
        blk_finish_plug(&plug);

        return ret;
}

static inline bool skip_inode_logging(const struct btrfs_log_ctx *ctx)
{
        struct btrfs_inode *inode = ctx->inode;
        struct btrfs_fs_info *fs_info = inode->root->fs_info;

        if (btrfs_inode_in_log(inode, btrfs_get_fs_generation(fs_info)) &&
            list_empty(&ctx->ordered_extents))
                return true;

        /*
         * If we are doing a fast fsync we can not bail out if the inode's
         * last_trans is <= then the last committed transaction, because we only
         * update the last_trans of the inode during ordered extent completion,
         * and for a fast fsync we don't wait for that, we only wait for the
         * writeback to complete.
         */
        if (inode->last_trans <= btrfs_get_last_trans_committed(fs_info) &&
            (test_bit(BTRFS_INODE_NEEDS_FULL_SYNC, &inode->runtime_flags) ||
             list_empty(&ctx->ordered_extents)))
                return true;

        return false;
}

/*
 * fsync call for both files and directories.  This logs the inode into
 * the tree log instead of forcing full commits whenever possible.
 *
 * It needs to call filemap_fdatawait so that all ordered extent updates are
 * in the metadata btree are up to date for copying to the log.
 *
 * It drops the inode mutex before doing the tree log commit.  This is an
 * important optimization for directories because holding the mutex prevents
 * new operations on the dir while we write to disk.
 */
int btrfs_sync_file(struct file *file, loff_t start, loff_t end, int datasync)
{
        struct dentry *dentry = file_dentry(file);
        struct btrfs_inode *inode = BTRFS_I(d_inode(dentry));
        struct btrfs_root *root = inode->root;
        struct btrfs_fs_info *fs_info = root->fs_info;
        struct btrfs_trans_handle *trans;
        struct btrfs_log_ctx ctx;
        int ret = 0, err;
        u64 len;
        bool full_sync;
        bool skip_ilock = false;

        if (current->journal_info == BTRFS_TRANS_DIO_WRITE_STUB) {
                skip_ilock = true;
                current->journal_info = NULL;
                btrfs_assert_inode_locked(inode);
        }

        trace_btrfs_sync_file_enter(file, datasync);

        btrfs_init_log_ctx(&ctx, inode);

        /*
         * Always set the range to a full range, otherwise we can get into
         * several problems, from missing file extent items to represent holes
         * when not using the NO_HOLES feature, to log tree corruption due to
         * races between hole detection during logging and completion of ordered
         * extents outside the range, to missing checksums due to ordered extents
         * for which we flushed only a subset of their pages.
         */
        start = 0;
        end = LLONG_MAX;
        len = (u64)LLONG_MAX + 1;

        /*
         * We write the dirty pages in the range and wait until they complete
         * out of the ->i_mutex. If so, we can flush the dirty pages by
         * multi-task, and make the performance up.  See
         * btrfs_wait_ordered_range for an explanation of the ASYNC check.
         */
        ret = start_ordered_ops(inode, start, end);
        if (ret)
                goto out;

        if (skip_ilock)
                down_write(&inode->i_mmap_lock);
        else
                btrfs_inode_lock(inode, BTRFS_ILOCK_MMAP);

        atomic_inc(&root->log_batch);

        /*
         * Before we acquired the inode's lock and the mmap lock, someone may
         * have dirtied more pages in the target range. We need to make sure
         * that writeback for any such pages does not start while we are logging
         * the inode, because if it does, any of the following might happen when
         * we are not doing a full inode sync:
         *
         * 1) We log an extent after its writeback finishes but before its
         *    checksums are added to the csum tree, leading to -EIO errors
         *    when attempting to read the extent after a log replay.
         *
         * 2) We can end up logging an extent before its writeback finishes.
         *    Therefore after the log replay we will have a file extent item
         *    pointing to an unwritten extent (and no data checksums as well).
         *
         * So trigger writeback for any eventual new dirty pages and then we
         * wait for all ordered extents to complete below.
         */
        ret = start_ordered_ops(inode, start, end);
        if (ret) {
                if (skip_ilock)
                        up_write(&inode->i_mmap_lock);
                else
                        btrfs_inode_unlock(inode, BTRFS_ILOCK_MMAP);
                goto out;
        }

        /*
         * Always check for the full sync flag while holding the inode's lock,
         * to avoid races with other tasks. The flag must be either set all the
         * time during logging or always off all the time while logging.
         * We check the flag here after starting delalloc above, because when
         * running delalloc the full sync flag may be set if we need to drop
         * extra extent map ranges due to temporary memory allocation failures.
         */
        full_sync = test_bit(BTRFS_INODE_NEEDS_FULL_SYNC, &inode->runtime_flags);

        /*
         * We have to do this here to avoid the priority inversion of waiting on
         * IO of a lower priority task while holding a transaction open.
         *
         * For a full fsync we wait for the ordered extents to complete while
         * for a fast fsync we wait just for writeback to complete, and then
         * attach the ordered extents to the transaction so that a transaction
         * commit waits for their completion, to avoid data loss if we fsync,
         * the current transaction commits before the ordered extents complete
         * and a power failure happens right after that.
         *
         * For zoned filesystem, if a write IO uses a ZONE_APPEND command, the
         * logical address recorded in the ordered extent may change. We need
         * to wait for the IO to stabilize the logical address.
         */
        if (full_sync || btrfs_is_zoned(fs_info)) {
                ret = btrfs_wait_ordered_range(inode, start, len);
                clear_bit(BTRFS_INODE_COW_WRITE_ERROR, &inode->runtime_flags);
        } else {
                /*
                 * Get our ordered extents as soon as possible to avoid doing
                 * checksum lookups in the csum tree, and use instead the
                 * checksums attached to the ordered extents.
                 */
                btrfs_get_ordered_extents_for_logging(inode, &ctx.ordered_extents);
                ret = filemap_fdatawait_range(inode->vfs_inode.i_mapping, start, end);
                if (ret)
                        goto out_release_extents;

                /*
                 * Check and clear the BTRFS_INODE_COW_WRITE_ERROR now after
                 * starting and waiting for writeback, because for buffered IO
                 * it may have been set during the end IO callback
                 * (end_bbio_data_write() -> btrfs_finish_ordered_extent()) in
                 * case an error happened and we need to wait for ordered
                 * extents to complete so that any extent maps that point to
                 * unwritten locations are dropped and we don't log them.
                 */
                if (test_and_clear_bit(BTRFS_INODE_COW_WRITE_ERROR, &inode->runtime_flags))
                        ret = btrfs_wait_ordered_range(inode, start, len);
        }

        if (ret)
                goto out_release_extents;

        atomic_inc(&root->log_batch);

        if (skip_inode_logging(&ctx)) {
                /*
                 * We've had everything committed since the last time we were
                 * modified so clear this flag in case it was set for whatever
                 * reason, it's no longer relevant.
                 */
                clear_bit(BTRFS_INODE_NEEDS_FULL_SYNC, &inode->runtime_flags);
                goto out_release_extents;
        }

        btrfs_init_log_ctx_scratch_eb(&ctx);

        /*
         * We use start here because we will need to wait on the IO to complete
         * in btrfs_sync_log, which could require joining a transaction (for
         * example checking cross references in the nocow path).  If we use join
         * here we could get into a situation where we're waiting on IO to
         * happen that is blocked on a transaction trying to commit.  With start
         * we inc the extwriter counter, so we wait for all extwriters to exit
         * before we start blocking joiners.  This comment is to keep somebody
         * from thinking they are super smart and changing this to
         * btrfs_join_transaction *cough*Josef*cough*.
         */
        trans = btrfs_start_transaction(root, 0);
        if (IS_ERR(trans)) {
                ret = PTR_ERR(trans);
                goto out_release_extents;
        }
        trans->in_fsync = true;

        ret = btrfs_log_dentry_safe(trans, dentry, &ctx);
        /*
         * Scratch eb no longer needed, release before syncing log or commit
         * transaction, to avoid holding unnecessary memory during such long
         * operations.
         */
        if (ctx.scratch_eb) {
                free_extent_buffer(ctx.scratch_eb);
                ctx.scratch_eb = NULL;
        }
        btrfs_release_log_ctx_extents(&ctx);
        if (ret < 0) {
                /* Fallthrough and commit/free transaction. */
                ret = BTRFS_LOG_FORCE_COMMIT;
        }

        /* we've logged all the items and now have a consistent
         * version of the file in the log.  It is possible that
         * someone will come in and modify the file, but that's
         * fine because the log is consistent on disk, and we
         * have references to all of the file's extents
         *
         * It is possible that someone will come in and log the
         * file again, but that will end up using the synchronization
         * inside btrfs_sync_log to keep things safe.
         */
        if (skip_ilock)
                up_write(&inode->i_mmap_lock);
        else
                btrfs_inode_unlock(inode, BTRFS_ILOCK_MMAP);

        if (ret == BTRFS_NO_LOG_SYNC) {
                ret = btrfs_end_transaction(trans);
                goto out;
        }

        /* We successfully logged the inode, attempt to sync the log. */
        if (!ret) {
                ret = btrfs_sync_log(trans, root, &ctx);
                if (!ret) {
                        ret = btrfs_end_transaction(trans);
                        goto out;
                }
        }

        /*
         * At this point we need to commit the transaction because we had
         * btrfs_need_log_full_commit() or some other error.
         *
         * If we didn't do a full sync we have to stop the trans handle, wait on
         * the ordered extents, start it again and commit the transaction.  If
         * we attempt to wait on the ordered extents here we could deadlock with
         * something like fallocate() that is holding the extent lock trying to
         * start a transaction while some other thread is trying to commit the
         * transaction while we (fsync) are currently holding the transaction
         * open.
         */
        if (!full_sync) {
                ret = btrfs_end_transaction(trans);
                if (ret)
                        goto out;
                ret = btrfs_wait_ordered_range(inode, start, len);
                if (ret)
                        goto out;

                /*
                 * This is safe to use here because we're only interested in
                 * making sure the transaction that had the ordered extents is
                 * committed.  We aren't waiting on anything past this point,
                 * we're purely getting the transaction and committing it.
                 */
                trans = btrfs_attach_transaction_barrier(root);
                if (IS_ERR(trans)) {
                        ret = PTR_ERR(trans);

                        /*
                         * We committed the transaction and there's no currently
                         * running transaction, this means everything we care
                         * about made it to disk and we are done.
                         */
                        if (ret == -ENOENT)
                                ret = 0;
                        goto out;
                }
        }

        ret = btrfs_commit_transaction(trans);
out:
        free_extent_buffer(ctx.scratch_eb);
        ASSERT(list_empty(&ctx.list));
        ASSERT(list_empty(&ctx.conflict_inodes));
        ASSERT(ret <= 0, "ret=%d", ret);
        /*
         * Ordered extents might have started and completed before this fsync,
         * so check for any io errors and advance the writeback error sequence.
         */
        err = file_check_and_advance_wb_err(file);
        if (!ret)
                ret = err;
        trace_btrfs_sync_file_exit(file, ret);

        return ret;

out_release_extents:
        btrfs_release_log_ctx_extents(&ctx);
        if (skip_ilock)
                up_write(&inode->i_mmap_lock);
        else
                btrfs_inode_unlock(inode, BTRFS_ILOCK_MMAP);
        goto out;
}

/*
 * btrfs_page_mkwrite() is not allowed to change the file size as it gets
 * called from a page fault handler when a page is first dirtied. Hence we must
 * be careful to check for EOF conditions here. We set the page up correctly
 * for a written page which means we get ENOSPC checking when writing into
 * holes and correct delalloc and unwritten extent mapping on filesystems that
 * support these features.
 *
 * We are not allowed to take the i_mutex here so we have to play games to
 * protect against truncate races as the page could now be beyond EOF.  Because
 * truncate_setsize() writes the inode size before removing pages, once we have
 * the page lock we can determine safely if the page is beyond EOF. If it is not
 * beyond EOF, then the page is guaranteed safe against truncation until we
 * unlock the page.
 */
static vm_fault_t btrfs_page_mkwrite(struct vm_fault *vmf)
{
        struct page *page = vmf->page;
        struct folio *folio = page_folio(page);
        struct btrfs_inode *inode = BTRFS_I(file_inode(vmf->vma->vm_file));
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        struct extent_io_tree *io_tree = &inode->io_tree;
        struct btrfs_ordered_extent *ordered;
        struct extent_state *cached_state = NULL;
        struct extent_changeset *data_reserved = NULL;
        unsigned long zero_start;
        loff_t size;
        size_t fsize = folio_size(folio);
        int ret;
        bool only_release_metadata = false;
        u64 reserved_space;
        u64 page_start;
        u64 page_end;
        u64 end;

        reserved_space = fsize;

        sb_start_pagefault(inode->vfs_inode.i_sb);
        page_start = folio_pos(folio);
        page_end = page_start + folio_size(folio) - 1;
        end = page_end;

        /*
         * Reserving delalloc space after obtaining the page lock can lead to
         * deadlock. For example, if a dirty page is locked by this function
         * and the call to btrfs_delalloc_reserve_space() ends up triggering
         * dirty page write out, then the btrfs_writepages() function could
         * end up waiting indefinitely to get a lock on the page currently
         * being processed by btrfs_page_mkwrite() function.
         */
        ret = btrfs_check_data_free_space(inode, &data_reserved, page_start,
                                          reserved_space, false);
        if (ret < 0) {
                size_t write_bytes = reserved_space;

                if (btrfs_check_nocow_lock(inode, page_start, &write_bytes, false) <= 0)
                        goto out_noreserve;

                only_release_metadata = true;

                /*
                 * Can't write the whole range, there may be shared extents or
                 * holes in the range, bail out with @only_release_metadata set
                 * to true so that we unlock the nocow lock before returning the
                 * error.
                 */
                if (write_bytes < reserved_space)
                        goto out_noreserve;
        }
        ret = btrfs_delalloc_reserve_metadata(inode, reserved_space,
                                              reserved_space, false);
        if (ret < 0) {
                if (!only_release_metadata)
                        btrfs_free_reserved_data_space(inode, data_reserved,
                                                       page_start, reserved_space);
                goto out_noreserve;
        }

        ret = file_update_time(vmf->vma->vm_file);
        if (ret < 0)
                goto out;
again:
        down_read(&inode->i_mmap_lock);
        folio_lock(folio);
        size = i_size_read(&inode->vfs_inode);

        if ((folio->mapping != inode->vfs_inode.i_mapping) ||
            (page_start >= size)) {
                /* Page got truncated out from underneath us. */
                goto out_unlock;
        }
        folio_wait_writeback(folio);

        btrfs_lock_extent(io_tree, page_start, page_end, &cached_state);
        ret = set_folio_extent_mapped(folio);
        if (ret < 0) {
                btrfs_unlock_extent(io_tree, page_start, page_end, &cached_state);
                goto out_unlock;
        }

        /*
         * We can't set the delalloc bits if there are pending ordered
         * extents.  Drop our locks and wait for them to finish.
         */
        ordered = btrfs_lookup_ordered_range(inode, page_start, fsize);
        if (ordered) {
                btrfs_unlock_extent(io_tree, page_start, page_end, &cached_state);
                folio_unlock(folio);
                up_read(&inode->i_mmap_lock);
                btrfs_start_ordered_extent(ordered);
                btrfs_put_ordered_extent(ordered);
                goto again;
        }

        if (folio_contains(folio, (size - 1) >> PAGE_SHIFT)) {
                reserved_space = round_up(size - page_start, fs_info->sectorsize);
                if (reserved_space < fsize) {
                        const u64 to_free = fsize - reserved_space;

                        end = page_start + reserved_space - 1;
                        if (only_release_metadata)
                                btrfs_delalloc_release_metadata(inode, to_free, true);
                        else
                                btrfs_delalloc_release_space(inode, data_reserved,
                                                             end + 1, to_free, true);
                }
        }

        ret = btrfs_reset_extent_delalloc(inode, page_start, end, 0, &cached_state);
        if (ret < 0) {
                btrfs_unlock_extent(io_tree, page_start, page_end, &cached_state);
                goto out_unlock;
        }

        /* Page is wholly or partially inside EOF. */
        if (page_start + folio_size(folio) > size)
                zero_start = offset_in_folio(folio, size);
        else
                zero_start = fsize;

        if (zero_start != fsize)
                folio_zero_range(folio, zero_start, folio_size(folio) - zero_start);

        btrfs_folio_set_dirty(fs_info, folio, page_start, end + 1 - page_start);
        btrfs_folio_set_uptodate(fs_info, folio, page_start, end + 1 - page_start);

        btrfs_set_inode_last_sub_trans(inode);

        if (only_release_metadata)
                btrfs_set_extent_bit(io_tree, page_start, end, EXTENT_NORESERVE,
                                     &cached_state);

        btrfs_unlock_extent(io_tree, page_start, page_end, &cached_state);
        up_read(&inode->i_mmap_lock);

        btrfs_delalloc_release_extents(inode, fsize);
        if (only_release_metadata)
                btrfs_check_nocow_unlock(inode);
        sb_end_pagefault(inode->vfs_inode.i_sb);
        extent_changeset_free(data_reserved);
        return VM_FAULT_LOCKED;

out_unlock:
        folio_unlock(folio);
        up_read(&inode->i_mmap_lock);
out:
        btrfs_delalloc_release_extents(inode, fsize);
        if (only_release_metadata)
                btrfs_delalloc_release_metadata(inode, reserved_space, true);
        else
                btrfs_delalloc_release_space(inode, data_reserved, page_start,
                                             reserved_space, true);
out_noreserve:
        if (only_release_metadata)
                btrfs_check_nocow_unlock(inode);

        sb_end_pagefault(inode->vfs_inode.i_sb);

        extent_changeset_free(data_reserved);

        if (ret < 0)
                return vmf_error(ret);

        /* Make the VM retry the fault. */
        return VM_FAULT_NOPAGE;
}

static const struct vm_operations_struct btrfs_file_vm_ops = {
        .fault                = filemap_fault,
        .map_pages        = filemap_map_pages,
        .page_mkwrite        = btrfs_page_mkwrite,
};

static int btrfs_file_mmap_prepare(struct vm_area_desc *desc)
{
        struct file *filp = desc->file;
        struct address_space *mapping = filp->f_mapping;

        if (btrfs_is_shutdown(inode_to_fs_info(file_inode(filp))))
                return -EIO;
        if (!mapping->a_ops->read_folio)
                return -ENOEXEC;

        file_accessed(filp);
        desc->vm_ops = &btrfs_file_vm_ops;

        return 0;
}

static bool hole_mergeable(struct btrfs_inode *inode, struct extent_buffer *leaf,
                           int slot, u64 start, u64 end)
{
        struct btrfs_file_extent_item *fi;
        struct btrfs_key key;

        if (slot < 0 || slot >= btrfs_header_nritems(leaf))
                return false;

        btrfs_item_key_to_cpu(leaf, &key, slot);
        if (key.objectid != btrfs_ino(inode) ||
            key.type != BTRFS_EXTENT_DATA_KEY)
                return false;

        fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);

        if (btrfs_file_extent_type(leaf, fi) != BTRFS_FILE_EXTENT_REG)
                return false;

        if (btrfs_file_extent_disk_bytenr(leaf, fi))
                return false;

        if (key.offset == end)
                return true;
        if (key.offset + btrfs_file_extent_num_bytes(leaf, fi) == start)
                return true;
        return false;
}

static int fill_holes(struct btrfs_trans_handle *trans,
                struct btrfs_inode *inode,
                struct btrfs_path *path, u64 offset, u64 end)
{
        struct btrfs_fs_info *fs_info = trans->fs_info;
        struct btrfs_root *root = inode->root;
        struct extent_buffer *leaf;
        struct btrfs_file_extent_item *fi;
        struct extent_map *hole_em;
        struct btrfs_key key;
        int modify_slot = -1;
        int del_slot = -1;
        bool update_offset = false;
        u64 num_bytes = 0;
        int ret;

        if (btrfs_fs_incompat(fs_info, NO_HOLES))
                goto out;

        key.objectid = btrfs_ino(inode);
        key.type = BTRFS_EXTENT_DATA_KEY;
        key.offset = offset;

        ret = btrfs_search_slot(trans, root, &key, path, -1, 1);
        if (ret <= 0) {
                /*
                 * We should have dropped this offset, so if we find it then
                 * something has gone horribly wrong.
                 */
                if (ret == 0)
                        ret = -EINVAL;
                return ret;
        }

        leaf = path->nodes[0];
        if (hole_mergeable(inode, leaf, path->slots[0] - 1, offset, end)) {
                fi = btrfs_item_ptr(leaf, path->slots[0] - 1,
                                    struct btrfs_file_extent_item);
                num_bytes = btrfs_file_extent_num_bytes(leaf, fi) +
                        end - offset;
                modify_slot = path->slots[0] - 1;
        }
        if (hole_mergeable(inode, leaf, path->slots[0], offset, end)) {
                fi = btrfs_item_ptr(leaf, path->slots[0],
                                    struct btrfs_file_extent_item);
                if (modify_slot != -1) {
                        num_bytes += btrfs_file_extent_num_bytes(leaf, fi);
                        del_slot = path->slots[0];
                } else {
                        num_bytes = btrfs_file_extent_num_bytes(leaf, fi) +
                                end - offset;
                        modify_slot = path->slots[0];
                        update_offset = true;
                }
        }
        if (modify_slot >= 0) {
                fi = btrfs_item_ptr(leaf, modify_slot,
                                    struct btrfs_file_extent_item);
                btrfs_set_file_extent_num_bytes(leaf, fi, num_bytes);
                btrfs_set_file_extent_ram_bytes(leaf, fi, num_bytes);
                if (update_offset) {
                        key.offset = offset;
                        btrfs_set_item_key_safe(trans, path, &key);
                }
                btrfs_set_file_extent_offset(leaf, fi, 0);
                btrfs_set_file_extent_generation(leaf, fi, trans->transid);
                if (del_slot >= 0) {
                        ret = btrfs_del_items(trans, root, path, del_slot, 1);
                        if (ret) {
                                btrfs_abort_transaction(trans, ret);
                                btrfs_release_path(path);
                                return ret;
                        }
                }
                goto out;
        }
        btrfs_release_path(path);

        ret = btrfs_insert_hole_extent(trans, root, btrfs_ino(inode), offset,
                                       end - offset);
        if (ret)
                return ret;

out:
        btrfs_release_path(path);

        hole_em = btrfs_alloc_extent_map();
        if (!hole_em) {
                btrfs_drop_extent_map_range(inode, offset, end - 1, false);
                btrfs_set_inode_full_sync(inode);
        } else {
                hole_em->start = offset;
                hole_em->len = end - offset;
                hole_em->ram_bytes = hole_em->len;

                hole_em->disk_bytenr = EXTENT_MAP_HOLE;
                hole_em->disk_num_bytes = 0;
                hole_em->generation = trans->transid;

                ret = btrfs_replace_extent_map_range(inode, hole_em, true);
                btrfs_free_extent_map(hole_em);
                if (ret)
                        btrfs_set_inode_full_sync(inode);
        }

        return 0;
}

/*
 * Find a hole extent on given inode and change start/len to the end of hole
 * extent.(hole/vacuum extent whose em->start <= start &&
 *           em->start + em->len > start)
 * When a hole extent is found, return 1 and modify start/len.
 */
static int find_first_non_hole(struct btrfs_inode *inode, u64 *start, u64 *len)
{
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        struct extent_map *em;
        int ret = 0;

        em = btrfs_get_extent(inode, NULL,
                              round_down(*start, fs_info->sectorsize),
                              round_up(*len, fs_info->sectorsize));
        if (IS_ERR(em))
                return PTR_ERR(em);

        /* Hole or vacuum extent(only exists in no-hole mode) */
        if (em->disk_bytenr == EXTENT_MAP_HOLE) {
                const u64 em_end = btrfs_extent_map_end(em);

                ret = 1;
                *len = (em_end > *start + *len) ? 0 : (*start + *len - em_end);
                *start = em_end;
        }
        btrfs_free_extent_map(em);
        return ret;
}

/*
 * Check if there is no folio in the range.
 *
 * We cannot utilize filemap_range_has_page() in a filemap with large folios
 * as we can hit the following false positive:
 *
 *        start                            end
 *        |                                |
 *  |//|//|//|//|  |  |  |  |  |  |  |  |//|//|
 *   \         /                         \   /
 *    Folio A                            Folio B
 *
 * That large folio A and B cover the start and end indexes.
 * In that case filemap_range_has_page() will always return true, but the above
 * case is fine for btrfs_punch_hole_lock_range() usage.
 *
 * So here we only ensure that no other folios is in the range, excluding the
 * head/tail large folio.
 */
static bool check_range_has_page(struct inode *inode, u64 start, u64 end)
{
        struct folio_batch fbatch;
        bool ret = false;
        /*
         * For subpage case, if the range is not at page boundary, we could
         * have pages at the leading/tailing part of the range.
         * This could lead to dead loop since filemap_range_has_page()
         * will always return true.
         * So here we need to do extra page alignment for
         * filemap_range_has_page().
         *
         * And do not decrease page_lockend right now, as it can be 0.
         */
        const u64 page_lockstart = round_up(start, PAGE_SIZE);
        const u64 page_lockend = round_down(end + 1, PAGE_SIZE);
        const pgoff_t start_index = page_lockstart >> PAGE_SHIFT;
        const pgoff_t end_index = (page_lockend - 1) >> PAGE_SHIFT;
        pgoff_t tmp = start_index;
        int found_folios;

        /* The same page or adjacent pages. */
        if (page_lockend <= page_lockstart)
                return false;

        folio_batch_init(&fbatch);
        found_folios = filemap_get_folios(inode->i_mapping, &tmp, end_index, &fbatch);
        for (int i = 0; i < found_folios; i++) {
                struct folio *folio = fbatch.folios[i];

                /* A large folio begins before the start. Not a target. */
                if (folio->index < start_index)
                        continue;
                /* A large folio extends beyond the end. Not a target. */
                if (folio_next_index(folio) > end_index)
                        continue;
                /* A folio doesn't cover the head/tail index. Found a target. */
                ret = true;
                break;
        }
        folio_batch_release(&fbatch);
        return ret;
}

static void btrfs_punch_hole_lock_range(struct inode *inode,
                                        const u64 lockstart, const u64 lockend,
                                        struct extent_state **cached_state)
{
        while (1) {
                truncate_pagecache_range(inode, lockstart, lockend);

                btrfs_lock_extent(&BTRFS_I(inode)->io_tree, lockstart, lockend,
                                  cached_state);
                /*
                 * We can't have ordered extents in the range, nor dirty/writeback
                 * pages, because we have locked the inode's VFS lock in exclusive
                 * mode, we have locked the inode's i_mmap_lock in exclusive mode,
                 * we have flushed all delalloc in the range and we have waited
                 * for any ordered extents in the range to complete.
                 * We can race with anyone reading pages from this range, so after
                 * locking the range check if we have pages in the range, and if
                 * we do, unlock the range and retry.
                 */
                if (!check_range_has_page(inode, lockstart, lockend))
                        break;

                btrfs_unlock_extent(&BTRFS_I(inode)->io_tree, lockstart, lockend,
                                    cached_state);
        }

        btrfs_assert_inode_range_clean(BTRFS_I(inode), lockstart, lockend);
}

static int btrfs_insert_replace_extent(struct btrfs_trans_handle *trans,
                                     struct btrfs_inode *inode,
                                     struct btrfs_path *path,
                                     struct btrfs_replace_extent_info *extent_info,
                                     const u64 replace_len,
                                     const u64 bytes_to_drop)
{
        struct btrfs_fs_info *fs_info = trans->fs_info;
        struct btrfs_root *root = inode->root;
        struct btrfs_file_extent_item *extent;
        struct extent_buffer *leaf;
        struct btrfs_key key;
        int slot;
        int ret;

        if (replace_len == 0)
                return 0;

        if (extent_info->disk_offset == 0 &&
            btrfs_fs_incompat(fs_info, NO_HOLES)) {
                btrfs_update_inode_bytes(inode, 0, bytes_to_drop);
                return 0;
        }

        key.objectid = btrfs_ino(inode);
        key.type = BTRFS_EXTENT_DATA_KEY;
        key.offset = extent_info->file_offset;
        ret = btrfs_insert_empty_item(trans, root, path, &key,
                                      sizeof(struct btrfs_file_extent_item));
        if (ret)
                return ret;
        leaf = path->nodes[0];
        slot = path->slots[0];
        write_extent_buffer(leaf, extent_info->extent_buf,
                            btrfs_item_ptr_offset(leaf, slot),
                            sizeof(struct btrfs_file_extent_item));
        extent = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
        ASSERT(btrfs_file_extent_type(leaf, extent) != BTRFS_FILE_EXTENT_INLINE);
        btrfs_set_file_extent_offset(leaf, extent, extent_info->data_offset);
        btrfs_set_file_extent_num_bytes(leaf, extent, replace_len);
        if (extent_info->is_new_extent)
                btrfs_set_file_extent_generation(leaf, extent, trans->transid);
        btrfs_release_path(path);

        ret = btrfs_inode_set_file_extent_range(inode, extent_info->file_offset,
                                                replace_len);
        if (ret)
                return ret;

        /* If it's a hole, nothing more needs to be done. */
        if (extent_info->disk_offset == 0) {
                btrfs_update_inode_bytes(inode, 0, bytes_to_drop);
                return 0;
        }

        btrfs_update_inode_bytes(inode, replace_len, bytes_to_drop);

        if (extent_info->is_new_extent && extent_info->insertions == 0) {
                key.objectid = extent_info->disk_offset;
                key.type = BTRFS_EXTENT_ITEM_KEY;
                key.offset = extent_info->disk_len;
                ret = btrfs_alloc_reserved_file_extent(trans, root,
                                                       btrfs_ino(inode),
                                                       extent_info->file_offset,
                                                       extent_info->qgroup_reserved,
                                                       &key);
        } else {
                struct btrfs_ref ref = {
                        .action = BTRFS_ADD_DELAYED_REF,
                        .bytenr = extent_info->disk_offset,
                        .num_bytes = extent_info->disk_len,
                        .owning_root = btrfs_root_id(root),
                        .ref_root = btrfs_root_id(root),
                };
                u64 ref_offset;

                ref_offset = extent_info->file_offset - extent_info->data_offset;
                btrfs_init_data_ref(&ref, btrfs_ino(inode), ref_offset, 0, false);
                ret = btrfs_inc_extent_ref(trans, &ref);
        }

        extent_info->insertions++;

        return ret;
}

/*
 * The respective range must have been previously locked, as well as the inode.
 * The end offset is inclusive (last byte of the range).
 * @extent_info is NULL for fallocate's hole punching and non-NULL when replacing
 * the file range with an extent.
 * When not punching a hole, we don't want to end up in a state where we dropped
 * extents without inserting a new one, so we must abort the transaction to avoid
 * a corruption.
 */
int btrfs_replace_file_extents(struct btrfs_inode *inode,
                               struct btrfs_path *path, const u64 start,
                               const u64 end,
                               struct btrfs_replace_extent_info *extent_info,
                               struct btrfs_trans_handle **trans_out)
{
        struct btrfs_drop_extents_args drop_args = { 0 };
        struct btrfs_root *root = inode->root;
        struct btrfs_fs_info *fs_info = root->fs_info;
        const u64 min_size = btrfs_calc_insert_metadata_size(fs_info, 1);
        u64 ino_size = round_up(inode->vfs_inode.i_size, fs_info->sectorsize);
        struct btrfs_trans_handle *trans = NULL;
        struct btrfs_block_rsv rsv;
        unsigned int rsv_count;
        u64 cur_offset;
        u64 len = end - start;
        int ret = 0;

        if (end <= start)
                return -EINVAL;

        btrfs_init_metadata_block_rsv(fs_info, &rsv, BTRFS_BLOCK_RSV_TEMP);
        rsv.size = min_size;
        rsv.failfast = true;

        /*
         * 1 - update the inode
         * 1 - removing the extents in the range
         * 1 - adding the hole extent if no_holes isn't set or if we are
         *     replacing the range with a new extent
         */
        if (!btrfs_fs_incompat(fs_info, NO_HOLES) || extent_info)
                rsv_count = 3;
        else
                rsv_count = 2;

        trans = btrfs_start_transaction(root, rsv_count);
        if (IS_ERR(trans)) {
                ret = PTR_ERR(trans);
                trans = NULL;
                goto out_release;
        }

        ret = btrfs_block_rsv_migrate(&fs_info->trans_block_rsv, &rsv,
                                      min_size, false);
        if (WARN_ON(ret))
                goto out_trans;
        trans->block_rsv = &rsv;

        cur_offset = start;
        drop_args.path = path;
        drop_args.end = end + 1;
        drop_args.drop_cache = true;
        while (cur_offset < end) {
                drop_args.start = cur_offset;
                ret = btrfs_drop_extents(trans, root, inode, &drop_args);
                /* If we are punching a hole decrement the inode's byte count */
                if (!extent_info)
                        btrfs_update_inode_bytes(inode, 0,
                                                 drop_args.bytes_found);
                if (ret != -ENOSPC) {
                        /*
                         * The only time we don't want to abort is if we are
                         * attempting to clone a partial inline extent, in which
                         * case we'll get EOPNOTSUPP.  However if we aren't
                         * clone we need to abort no matter what, because if we
                         * got EOPNOTSUPP via prealloc then we messed up and
                         * need to abort.
                         */
                        if (unlikely(ret &&
                                     (ret != -EOPNOTSUPP ||
                                      (extent_info && extent_info->is_new_extent))))
                                btrfs_abort_transaction(trans, ret);
                        break;
                }

                trans->block_rsv = &fs_info->trans_block_rsv;

                if (!extent_info && cur_offset < drop_args.drop_end &&
                    cur_offset < ino_size) {
                        ret = fill_holes(trans, inode, path, cur_offset,
                                         drop_args.drop_end);
                        if (unlikely(ret)) {
                                /*
                                 * If we failed then we didn't insert our hole
                                 * entries for the area we dropped, so now the
                                 * fs is corrupted, so we must abort the
                                 * transaction.
                                 */
                                btrfs_abort_transaction(trans, ret);
                                break;
                        }
                } else if (!extent_info && cur_offset < drop_args.drop_end) {
                        /*
                         * We are past the i_size here, but since we didn't
                         * insert holes we need to clear the mapped area so we
                         * know to not set disk_i_size in this area until a new
                         * file extent is inserted here.
                         */
                        ret = btrfs_inode_clear_file_extent_range(inode,
                                        cur_offset,
                                        drop_args.drop_end - cur_offset);
                        if (unlikely(ret)) {
                                /*
                                 * We couldn't clear our area, so we could
                                 * presumably adjust up and corrupt the fs, so
                                 * we need to abort.
                                 */
                                btrfs_abort_transaction(trans, ret);
                                break;
                        }
                }

                if (extent_info &&
                    drop_args.drop_end > extent_info->file_offset) {
                        u64 replace_len = drop_args.drop_end -
                                          extent_info->file_offset;

                        ret = btrfs_insert_replace_extent(trans, inode,        path,
                                        extent_info, replace_len,
                                        drop_args.bytes_found);
                        if (unlikely(ret)) {
                                btrfs_abort_transaction(trans, ret);
                                break;
                        }
                        extent_info->data_len -= replace_len;
                        extent_info->data_offset += replace_len;
                        extent_info->file_offset += replace_len;
                }

                /*
                 * We are releasing our handle on the transaction, balance the
                 * dirty pages of the btree inode and flush delayed items, and
                 * then get a new transaction handle, which may now point to a
                 * new transaction in case someone else may have committed the
                 * transaction we used to replace/drop file extent items. So
                 * bump the inode's iversion and update mtime and ctime except
                 * if we are called from a dedupe context. This is because a
                 * power failure/crash may happen after the transaction is
                 * committed and before we finish replacing/dropping all the
                 * file extent items we need.
                 */
                inode_inc_iversion(&inode->vfs_inode);

                if (!extent_info || extent_info->update_times)
                        inode_set_mtime_to_ts(&inode->vfs_inode,
                                              inode_set_ctime_current(&inode->vfs_inode));

                ret = btrfs_update_inode(trans, inode);
                if (ret)
                        break;

                btrfs_end_transaction(trans);
                btrfs_btree_balance_dirty(fs_info);

                trans = btrfs_start_transaction(root, rsv_count);
                if (IS_ERR(trans)) {
                        ret = PTR_ERR(trans);
                        trans = NULL;
                        break;
                }

                ret = btrfs_block_rsv_migrate(&fs_info->trans_block_rsv,
                                              &rsv, min_size, false);
                if (WARN_ON(ret))
                        break;
                trans->block_rsv = &rsv;

                cur_offset = drop_args.drop_end;
                len = end - cur_offset;
                if (!extent_info && len) {
                        ret = find_first_non_hole(inode, &cur_offset, &len);
                        if (unlikely(ret < 0))
                                break;
                        if (ret && !len) {
                                ret = 0;
                                break;
                        }
                }
        }

        /*
         * If we were cloning, force the next fsync to be a full one since we
         * we replaced (or just dropped in the case of cloning holes when
         * NO_HOLES is enabled) file extent items and did not setup new extent
         * maps for the replacement extents (or holes).
         */
        if (extent_info && !extent_info->is_new_extent)
                btrfs_set_inode_full_sync(inode);

        if (ret)
                goto out_trans;

        trans->block_rsv = &fs_info->trans_block_rsv;
        /*
         * If we are using the NO_HOLES feature we might have had already an
         * hole that overlaps a part of the region [lockstart, lockend] and
         * ends at (or beyond) lockend. Since we have no file extent items to
         * represent holes, drop_end can be less than lockend and so we must
         * make sure we have an extent map representing the existing hole (the
         * call to __btrfs_drop_extents() might have dropped the existing extent
         * map representing the existing hole), otherwise the fast fsync path
         * will not record the existence of the hole region
         * [existing_hole_start, lockend].
         */
        if (drop_args.drop_end <= end)
                drop_args.drop_end = end + 1;
        /*
         * Don't insert file hole extent item if it's for a range beyond eof
         * (because it's useless) or if it represents a 0 bytes range (when
         * cur_offset == drop_end).
         */
        if (!extent_info && cur_offset < ino_size &&
            cur_offset < drop_args.drop_end) {
                ret = fill_holes(trans, inode, path, cur_offset,
                                 drop_args.drop_end);
                if (unlikely(ret)) {
                        /* Same comment as above. */
                        btrfs_abort_transaction(trans, ret);
                        goto out_trans;
                }
        } else if (!extent_info && cur_offset < drop_args.drop_end) {
                /* See the comment in the loop above for the reasoning here. */
                ret = btrfs_inode_clear_file_extent_range(inode, cur_offset,
                                        drop_args.drop_end - cur_offset);
                if (unlikely(ret)) {
                        btrfs_abort_transaction(trans, ret);
                        goto out_trans;
                }

        }
        if (extent_info) {
                ret = btrfs_insert_replace_extent(trans, inode, path,
                                extent_info, extent_info->data_len,
                                drop_args.bytes_found);
                if (unlikely(ret)) {
                        btrfs_abort_transaction(trans, ret);
                        goto out_trans;
                }
        }

out_trans:
        if (!trans)
                goto out_release;

        trans->block_rsv = &fs_info->trans_block_rsv;
        if (ret)
                btrfs_end_transaction(trans);
        else
                *trans_out = trans;
out_release:
        btrfs_block_rsv_release(fs_info, &rsv, (u64)-1, NULL);
        return ret;
}

static int btrfs_punch_hole(struct file *file, loff_t offset, loff_t len)
{
        struct inode *inode = file_inode(file);
        struct btrfs_fs_info *fs_info = inode_to_fs_info(inode);
        struct btrfs_root *root = BTRFS_I(inode)->root;
        struct extent_state *cached_state = NULL;
        struct btrfs_path *path;
        struct btrfs_trans_handle *trans = NULL;
        u64 lockstart;
        u64 lockend;
        u64 tail_start;
        u64 tail_len;
        const u64 orig_start = offset;
        const u64 orig_end = offset + len - 1;
        int ret = 0;
        bool same_block;
        u64 ino_size;
        bool truncated_block = false;
        bool updated_inode = false;

        btrfs_inode_lock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);

        ret = btrfs_wait_ordered_range(BTRFS_I(inode), offset, len);
        if (ret)
                goto out_only_mutex;

        ino_size = round_up(inode->i_size, fs_info->sectorsize);
        ret = find_first_non_hole(BTRFS_I(inode), &offset, &len);
        if (ret < 0)
                goto out_only_mutex;
        if (ret && !len) {
                /* Already in a large hole */
                ret = 0;
                goto out_only_mutex;
        }

        ret = file_modified(file);
        if (ret)
                goto out_only_mutex;

        lockstart = round_up(offset, fs_info->sectorsize);
        lockend = round_down(offset + len, fs_info->sectorsize) - 1;
        same_block = (BTRFS_BYTES_TO_BLKS(fs_info, offset))
                == (BTRFS_BYTES_TO_BLKS(fs_info, offset + len - 1));
        /*
         * Only do this if we are in the same block and we aren't doing the
         * entire block.
         */
        if (same_block && len < fs_info->sectorsize) {
                if (offset < ino_size) {
                        truncated_block = true;
                        ret = btrfs_truncate_block(BTRFS_I(inode), offset + len - 1,
                                                   orig_start, orig_end);
                } else {
                        ret = 0;
                }
                goto out_only_mutex;
        }

        /* zero back part of the first block */
        if (offset < ino_size) {
                truncated_block = true;
                ret = btrfs_truncate_block(BTRFS_I(inode), offset, orig_start, orig_end);
                if (ret) {
                        btrfs_inode_unlock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);
                        return ret;
                }
        }

        /* Check the aligned pages after the first unaligned page,
         * if offset != orig_start, which means the first unaligned page
         * including several following pages are already in holes,
         * the extra check can be skipped */
        if (offset == orig_start) {
                /* after truncate page, check hole again */
                len = offset + len - lockstart;
                offset = lockstart;
                ret = find_first_non_hole(BTRFS_I(inode), &offset, &len);
                if (ret < 0)
                        goto out_only_mutex;
                if (ret && !len) {
                        ret = 0;
                        goto out_only_mutex;
                }
                lockstart = offset;
        }

        /* Check the tail unaligned part is in a hole */
        tail_start = lockend + 1;
        tail_len = offset + len - tail_start;
        if (tail_len) {
                ret = find_first_non_hole(BTRFS_I(inode), &tail_start, &tail_len);
                if (unlikely(ret < 0))
                        goto out_only_mutex;
                if (!ret) {
                        /* zero the front end of the last page */
                        if (tail_start + tail_len < ino_size) {
                                truncated_block = true;
                                ret = btrfs_truncate_block(BTRFS_I(inode),
                                                        tail_start + tail_len - 1,
                                                        orig_start, orig_end);
                                if (ret)
                                        goto out_only_mutex;
                        }
                }
        }

        if (lockend < lockstart) {
                ret = 0;
                goto out_only_mutex;
        }

        btrfs_punch_hole_lock_range(inode, lockstart, lockend, &cached_state);

        path = btrfs_alloc_path();
        if (!path) {
                ret = -ENOMEM;
                goto out;
        }

        ret = btrfs_replace_file_extents(BTRFS_I(inode), path, lockstart,
                                         lockend, NULL, &trans);
        btrfs_free_path(path);
        if (ret)
                goto out;

        ASSERT(trans != NULL);
        inode_inc_iversion(inode);
        inode_set_mtime_to_ts(inode, inode_set_ctime_current(inode));
        ret = btrfs_update_inode(trans, BTRFS_I(inode));
        updated_inode = true;
        btrfs_end_transaction(trans);
        btrfs_btree_balance_dirty(fs_info);
out:
        btrfs_unlock_extent(&BTRFS_I(inode)->io_tree, lockstart, lockend,
                            &cached_state);
out_only_mutex:
        if (!updated_inode && truncated_block && !ret) {
                /*
                 * If we only end up zeroing part of a page, we still need to
                 * update the inode item, so that all the time fields are
                 * updated as well as the necessary btrfs inode in memory fields
                 * for detecting, at fsync time, if the inode isn't yet in the
                 * log tree or it's there but not up to date.
                 */
                struct timespec64 now = inode_set_ctime_current(inode);

                inode_inc_iversion(inode);
                inode_set_mtime_to_ts(inode, now);
                trans = btrfs_start_transaction(root, 1);
                if (IS_ERR(trans)) {
                        ret = PTR_ERR(trans);
                } else {
                        int ret2;

                        ret = btrfs_update_inode(trans, BTRFS_I(inode));
                        ret2 = btrfs_end_transaction(trans);
                        if (!ret)
                                ret = ret2;
                }
        }
        btrfs_inode_unlock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);
        return ret;
}

/* Helper structure to record which range is already reserved */
struct falloc_range {
        struct list_head list;
        u64 start;
        u64 len;
};

/*
 * Helper function to add falloc range
 *
 * Caller should have locked the larger range of extent containing
 * [start, len)
 */
static int add_falloc_range(struct list_head *head, u64 start, u64 len)
{
        struct falloc_range *range = NULL;

        if (!list_empty(head)) {
                /*
                 * As fallocate iterates by bytenr order, we only need to check
                 * the last range.
                 */
                range = list_last_entry(head, struct falloc_range, list);
                if (range->start + range->len == start) {
                        range->len += len;
                        return 0;
                }
        }

        range = kmalloc_obj(*range);
        if (!range)
                return -ENOMEM;
        range->start = start;
        range->len = len;
        list_add_tail(&range->list, head);
        return 0;
}

static int btrfs_fallocate_update_isize(struct inode *inode,
                                        const u64 end,
                                        const int mode)
{
        struct btrfs_trans_handle *trans;
        struct btrfs_root *root = BTRFS_I(inode)->root;
        u64 range_start;
        u64 range_end;
        int ret;
        int ret2;

        if (mode & FALLOC_FL_KEEP_SIZE || end <= i_size_read(inode))
                return 0;

        range_start = round_down(i_size_read(inode), root->fs_info->sectorsize);
        range_end = round_up(end, root->fs_info->sectorsize);

        ret = btrfs_inode_set_file_extent_range(BTRFS_I(inode), range_start,
                                                range_end - range_start);
        if (ret)
                return ret;

        trans = btrfs_start_transaction(root, 1);
        if (IS_ERR(trans))
                return PTR_ERR(trans);

        inode_set_ctime_current(inode);
        i_size_write(inode, end);
        btrfs_inode_safe_disk_i_size_write(BTRFS_I(inode), 0);
        ret = btrfs_update_inode(trans, BTRFS_I(inode));
        ret2 = btrfs_end_transaction(trans);

        return ret ? ret : ret2;
}

enum {
        RANGE_BOUNDARY_WRITTEN_EXTENT,
        RANGE_BOUNDARY_PREALLOC_EXTENT,
        RANGE_BOUNDARY_HOLE,
};

static int btrfs_zero_range_check_range_boundary(struct btrfs_inode *inode,
                                                 u64 offset)
{
        const u64 sectorsize = inode->root->fs_info->sectorsize;
        struct extent_map *em;
        int ret;

        offset = round_down(offset, sectorsize);
        em = btrfs_get_extent(inode, NULL, offset, sectorsize);
        if (IS_ERR(em))
                return PTR_ERR(em);

        if (em->disk_bytenr == EXTENT_MAP_HOLE)
                ret = RANGE_BOUNDARY_HOLE;
        else if (em->flags & EXTENT_FLAG_PREALLOC)
                ret = RANGE_BOUNDARY_PREALLOC_EXTENT;
        else
                ret = RANGE_BOUNDARY_WRITTEN_EXTENT;

        btrfs_free_extent_map(em);
        return ret;
}

static int btrfs_zero_range(struct inode *inode,
                            loff_t offset,
                            loff_t len,
                            const int mode)
{
        struct btrfs_fs_info *fs_info = BTRFS_I(inode)->root->fs_info;
        struct extent_map *em;
        struct extent_changeset *data_reserved = NULL;
        int ret;
        u64 alloc_hint = 0;
        const u64 sectorsize = fs_info->sectorsize;
        const u64 orig_start = offset;
        const u64 orig_end = offset + len - 1;
        u64 alloc_start = round_down(offset, sectorsize);
        u64 alloc_end = round_up(offset + len, sectorsize);
        u64 bytes_to_reserve = 0;
        bool space_reserved = false;

        em = btrfs_get_extent(BTRFS_I(inode), NULL, alloc_start,
                              alloc_end - alloc_start);
        if (IS_ERR(em)) {
                ret = PTR_ERR(em);
                goto out;
        }

        /*
         * Avoid hole punching and extent allocation for some cases. More cases
         * could be considered, but these are unlikely common and we keep things
         * as simple as possible for now. Also, intentionally, if the target
         * range contains one or more prealloc extents together with regular
         * extents and holes, we drop all the existing extents and allocate a
         * new prealloc extent, so that we get a larger contiguous disk extent.
         */
        if (em->start <= alloc_start && (em->flags & EXTENT_FLAG_PREALLOC)) {
                const u64 em_end = btrfs_extent_map_end(em);

                if (em_end >= offset + len) {
                        /*
                         * The whole range is already a prealloc extent,
                         * do nothing except updating the inode's i_size if
                         * needed.
                         */
                        btrfs_free_extent_map(em);
                        ret = btrfs_fallocate_update_isize(inode, offset + len,
                                                           mode);
                        goto out;
                }
                /*
                 * Part of the range is already a prealloc extent, so operate
                 * only on the remaining part of the range.
                 */
                alloc_start = em_end;
                ASSERT(IS_ALIGNED(alloc_start, sectorsize));
                len = offset + len - alloc_start;
                offset = alloc_start;
                alloc_hint = btrfs_extent_map_block_start(em) + em->len;
        }
        btrfs_free_extent_map(em);

        if (BTRFS_BYTES_TO_BLKS(fs_info, offset) ==
            BTRFS_BYTES_TO_BLKS(fs_info, offset + len - 1)) {
                em = btrfs_get_extent(BTRFS_I(inode), NULL, alloc_start, sectorsize);
                if (IS_ERR(em)) {
                        ret = PTR_ERR(em);
                        goto out;
                }

                if (em->flags & EXTENT_FLAG_PREALLOC) {
                        btrfs_free_extent_map(em);
                        ret = btrfs_fallocate_update_isize(inode, offset + len,
                                                           mode);
                        goto out;
                }
                if (len < sectorsize && em->disk_bytenr != EXTENT_MAP_HOLE) {
                        btrfs_free_extent_map(em);
                        ret = btrfs_truncate_block(BTRFS_I(inode), offset + len - 1,
                                                   orig_start, orig_end);
                        if (!ret)
                                ret = btrfs_fallocate_update_isize(inode,
                                                                   offset + len,
                                                                   mode);
                        return ret;
                }
                btrfs_free_extent_map(em);
                alloc_start = round_down(offset, sectorsize);
                alloc_end = alloc_start + sectorsize;
                goto reserve_space;
        }

        alloc_start = round_up(offset, sectorsize);
        alloc_end = round_down(offset + len, sectorsize);

        /*
         * For unaligned ranges, check the pages at the boundaries, they might
         * map to an extent, in which case we need to partially zero them, or
         * they might map to a hole, in which case we need our allocation range
         * to cover them.
         */
        if (!IS_ALIGNED(offset, sectorsize)) {
                ret = btrfs_zero_range_check_range_boundary(BTRFS_I(inode),
                                                            offset);
                if (ret < 0)
                        goto out;
                if (ret == RANGE_BOUNDARY_HOLE) {
                        alloc_start = round_down(offset, sectorsize);
                        ret = 0;
                } else if (ret == RANGE_BOUNDARY_WRITTEN_EXTENT) {
                        ret = btrfs_truncate_block(BTRFS_I(inode), offset,
                                                   orig_start, orig_end);
                        if (ret)
                                goto out;
                } else {
                        ret = 0;
                }
        }

        if (!IS_ALIGNED(offset + len, sectorsize)) {
                ret = btrfs_zero_range_check_range_boundary(BTRFS_I(inode),
                                                            offset + len);
                if (ret < 0)
                        goto out;
                if (ret == RANGE_BOUNDARY_HOLE) {
                        alloc_end = round_up(offset + len, sectorsize);
                        ret = 0;
                } else if (ret == RANGE_BOUNDARY_WRITTEN_EXTENT) {
                        ret = btrfs_truncate_block(BTRFS_I(inode), offset + len - 1,
                                                   orig_start, orig_end);
                        if (ret)
                                goto out;
                } else {
                        ret = 0;
                }
        }

reserve_space:
        if (alloc_start < alloc_end) {
                struct extent_state *cached_state = NULL;
                const u64 lockstart = alloc_start;
                const u64 lockend = alloc_end - 1;

                bytes_to_reserve = alloc_end - alloc_start;
                ret = btrfs_alloc_data_chunk_ondemand(BTRFS_I(inode),
                                                      bytes_to_reserve);
                if (ret < 0)
                        goto out;
                space_reserved = true;
                btrfs_punch_hole_lock_range(inode, lockstart, lockend,
                                            &cached_state);
                ret = btrfs_qgroup_reserve_data(BTRFS_I(inode), &data_reserved,
                                                alloc_start, bytes_to_reserve);
                if (ret) {
                        btrfs_unlock_extent(&BTRFS_I(inode)->io_tree, lockstart,
                                            lockend, &cached_state);
                        goto out;
                }
                ret = btrfs_prealloc_file_range(inode, mode, alloc_start,
                                                alloc_end - alloc_start,
                                                fs_info->sectorsize,
                                                offset + len, &alloc_hint);
                btrfs_unlock_extent(&BTRFS_I(inode)->io_tree, lockstart, lockend,
                                    &cached_state);
                /* btrfs_prealloc_file_range releases reserved space on error */
                if (ret) {
                        space_reserved = false;
                        goto out;
                }
        }
        ret = btrfs_fallocate_update_isize(inode, offset + len, mode);
 out:
        if (ret && space_reserved)
                btrfs_free_reserved_data_space(BTRFS_I(inode), data_reserved,
                                               alloc_start, bytes_to_reserve);
        extent_changeset_free(data_reserved);

        return ret;
}

static long btrfs_fallocate(struct file *file, int mode,
                            loff_t offset, loff_t len)
{
        struct inode *inode = file_inode(file);
        struct extent_state *cached_state = NULL;
        struct extent_changeset *data_reserved = NULL;
        struct falloc_range *range;
        struct falloc_range *tmp;
        LIST_HEAD(reserve_list);
        u64 cur_offset;
        u64 last_byte;
        u64 alloc_start;
        u64 alloc_end;
        u64 alloc_hint = 0;
        u64 locked_end;
        u64 actual_end = 0;
        u64 data_space_needed = 0;
        u64 data_space_reserved = 0;
        u64 qgroup_reserved = 0;
        struct extent_map *em;
        int blocksize = BTRFS_I(inode)->root->fs_info->sectorsize;
        int ret;

        if (btrfs_is_shutdown(inode_to_fs_info(inode)))
                return -EIO;

        /* Do not allow fallocate in ZONED mode */
        if (btrfs_is_zoned(inode_to_fs_info(inode)))
                return -EOPNOTSUPP;

        alloc_start = round_down(offset, blocksize);
        alloc_end = round_up(offset + len, blocksize);
        cur_offset = alloc_start;

        /* Make sure we aren't being give some crap mode */
        if (mode & ~(FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE |
                     FALLOC_FL_ZERO_RANGE))
                return -EOPNOTSUPP;

        if (mode & FALLOC_FL_PUNCH_HOLE)
                return btrfs_punch_hole(file, offset, len);

        btrfs_inode_lock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);

        if (!(mode & FALLOC_FL_KEEP_SIZE) && offset + len > inode->i_size) {
                ret = inode_newsize_ok(inode, offset + len);
                if (ret)
                        goto out;
        }

        ret = file_modified(file);
        if (ret)
                goto out;

        /*
         * TODO: Move these two operations after we have checked
         * accurate reserved space, or fallocate can still fail but
         * with page truncated or size expanded.
         *
         * But that's a minor problem and won't do much harm BTW.
         */
        if (alloc_start > inode->i_size) {
                ret = btrfs_cont_expand(BTRFS_I(inode), i_size_read(inode),
                                        alloc_start);
                if (ret)
                        goto out;
        } else if (offset + len > inode->i_size) {
                /*
                 * If we are fallocating from the end of the file onward we
                 * need to zero out the end of the block if i_size lands in the
                 * middle of a block.
                 */
                ret = btrfs_truncate_block(BTRFS_I(inode), inode->i_size,
                                           inode->i_size, (u64)-1);
                if (ret)
                        goto out;
        }

        /*
         * We have locked the inode at the VFS level (in exclusive mode) and we
         * have locked the i_mmap_lock lock (in exclusive mode). Now before
         * locking the file range, flush all dealloc in the range and wait for
         * all ordered extents in the range to complete. After this we can lock
         * the file range and, due to the previous locking we did, we know there
         * can't be more delalloc or ordered extents in the range.
         */
        ret = btrfs_wait_ordered_range(BTRFS_I(inode), alloc_start,
                                       alloc_end - alloc_start);
        if (ret)
                goto out;

        if (mode & FALLOC_FL_ZERO_RANGE) {
                ret = btrfs_zero_range(inode, offset, len, mode);
                btrfs_inode_unlock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);
                return ret;
        }

        locked_end = alloc_end - 1;
        btrfs_lock_extent(&BTRFS_I(inode)->io_tree, alloc_start, locked_end,
                          &cached_state);

        btrfs_assert_inode_range_clean(BTRFS_I(inode), alloc_start, locked_end);

        /* First, check if we exceed the qgroup limit */
        while (cur_offset < alloc_end) {
                em = btrfs_get_extent(BTRFS_I(inode), NULL, cur_offset,
                                      alloc_end - cur_offset);
                if (IS_ERR(em)) {
                        ret = PTR_ERR(em);
                        break;
                }
                last_byte = min(btrfs_extent_map_end(em), alloc_end);
                actual_end = min_t(u64, btrfs_extent_map_end(em), offset + len);
                last_byte = ALIGN(last_byte, blocksize);
                if (em->disk_bytenr == EXTENT_MAP_HOLE ||
                    (cur_offset >= inode->i_size &&
                     !(em->flags & EXTENT_FLAG_PREALLOC))) {
                        const u64 range_len = last_byte - cur_offset;

                        ret = add_falloc_range(&reserve_list, cur_offset, range_len);
                        if (ret < 0) {
                                btrfs_free_extent_map(em);
                                break;
                        }
                        ret = btrfs_qgroup_reserve_data(BTRFS_I(inode),
                                        &data_reserved, cur_offset, range_len);
                        if (ret < 0) {
                                btrfs_free_extent_map(em);
                                break;
                        }
                        qgroup_reserved += range_len;
                        data_space_needed += range_len;
                }
                btrfs_free_extent_map(em);
                cur_offset = last_byte;
        }

        if (!ret && data_space_needed > 0) {
                /*
                 * We are safe to reserve space here as we can't have delalloc
                 * in the range, see above.
                 */
                ret = btrfs_alloc_data_chunk_ondemand(BTRFS_I(inode),
                                                      data_space_needed);
                if (!ret)
                        data_space_reserved = data_space_needed;
        }

        /*
         * If ret is still 0, means we're OK to fallocate.
         * Or just cleanup the list and exit.
         */
        list_for_each_entry_safe(range, tmp, &reserve_list, list) {
                if (!ret) {
                        ret = btrfs_prealloc_file_range(inode, mode,
                                        range->start,
                                        range->len, blocksize,
                                        offset + len, &alloc_hint);
                        /*
                         * btrfs_prealloc_file_range() releases space even
                         * if it returns an error.
                         */
                        data_space_reserved -= range->len;
                        qgroup_reserved -= range->len;
                } else if (data_space_reserved > 0) {
                        btrfs_free_reserved_data_space(BTRFS_I(inode),
                                               data_reserved, range->start,
                                               range->len);
                        data_space_reserved -= range->len;
                        qgroup_reserved -= range->len;
                } else if (qgroup_reserved > 0) {
                        btrfs_qgroup_free_data(BTRFS_I(inode), data_reserved,
                                               range->start, range->len, NULL);
                        qgroup_reserved -= range->len;
                }
                list_del(&range->list);
                kfree(range);
        }
        if (ret < 0)
                goto out_unlock;

        /*
         * We didn't need to allocate any more space, but we still extended the
         * size of the file so we need to update i_size and the inode item.
         */
        ret = btrfs_fallocate_update_isize(inode, actual_end, mode);
out_unlock:
        btrfs_unlock_extent(&BTRFS_I(inode)->io_tree, alloc_start, locked_end,
                            &cached_state);
out:
        btrfs_inode_unlock(BTRFS_I(inode), BTRFS_ILOCK_MMAP);
        extent_changeset_free(data_reserved);
        return ret;
}

/*
 * Helper for btrfs_find_delalloc_in_range(). Find a subrange in a given range
 * that has unflushed and/or flushing delalloc. There might be other adjacent
 * subranges after the one it found, so btrfs_find_delalloc_in_range() keeps
 * looping while it gets adjacent subranges, and merging them together.
 */
static bool find_delalloc_subrange(struct btrfs_inode *inode, u64 start, u64 end,
                                   struct extent_state **cached_state,
                                   bool *search_io_tree,
                                   u64 *delalloc_start_ret, u64 *delalloc_end_ret)
{
        u64 len = end + 1 - start;
        u64 delalloc_len = 0;
        struct btrfs_ordered_extent *oe;
        u64 oe_start;
        u64 oe_end;

        /*
         * Search the io tree first for EXTENT_DELALLOC. If we find any, it
         * means we have delalloc (dirty pages) for which writeback has not
         * started yet.
         */
        if (*search_io_tree) {
                spin_lock(&inode->lock);
                if (inode->delalloc_bytes > 0) {
                        spin_unlock(&inode->lock);
                        *delalloc_start_ret = start;
                        delalloc_len = btrfs_count_range_bits(&inode->io_tree,
                                                              delalloc_start_ret, end,
                                                              len, EXTENT_DELALLOC,
                                                              true, cached_state);
                } else {
                        spin_unlock(&inode->lock);
                }
        }

        if (delalloc_len > 0) {
                /*
                 * If delalloc was found then *delalloc_start_ret has a sector size
                 * aligned value (rounded down).
                 */
                *delalloc_end_ret = *delalloc_start_ret + delalloc_len - 1;

                if (*delalloc_start_ret == start) {
                        /* Delalloc for the whole range, nothing more to do. */
                        if (*delalloc_end_ret == end)
                                return true;
                        /* Else trim our search range for ordered extents. */
                        start = *delalloc_end_ret + 1;
                        len = end + 1 - start;
                }
        } else {
                /* No delalloc, future calls don't need to search again. */
                *search_io_tree = false;
        }

        /*
         * Now also check if there's any ordered extent in the range.
         * We do this because:
         *
         * 1) When delalloc is flushed, the file range is locked, we clear the
         *    EXTENT_DELALLOC bit from the io tree and create an extent map and
         *    an ordered extent for the write. So we might just have been called
         *    after delalloc is flushed and before the ordered extent completes
         *    and inserts the new file extent item in the subvolume's btree;
         *
         * 2) We may have an ordered extent created by flushing delalloc for a
         *    subrange that starts before the subrange we found marked with
         *    EXTENT_DELALLOC in the io tree.
         *
         * We could also use the extent map tree to find such delalloc that is
         * being flushed, but using the ordered extents tree is more efficient
         * because it's usually much smaller as ordered extents are removed from
         * the tree once they complete. With the extent maps, we may have them
         * in the extent map tree for a very long time, and they were either
         * created by previous writes or loaded by read operations.
         */
        oe = btrfs_lookup_first_ordered_range(inode, start, len);
        if (!oe)
                return (delalloc_len > 0);

        /* The ordered extent may span beyond our search range. */
        oe_start = max(oe->file_offset, start);
        oe_end = min(oe->file_offset + oe->num_bytes - 1, end);

        btrfs_put_ordered_extent(oe);

        /* Don't have unflushed delalloc, return the ordered extent range. */
        if (delalloc_len == 0) {
                *delalloc_start_ret = oe_start;
                *delalloc_end_ret = oe_end;
                return true;
        }

        /*
         * We have both unflushed delalloc (io_tree) and an ordered extent.
         * If the ranges are adjacent returned a combined range, otherwise
         * return the leftmost range.
         */
        if (oe_start < *delalloc_start_ret) {
                if (oe_end < *delalloc_start_ret)
                        *delalloc_end_ret = oe_end;
                *delalloc_start_ret = oe_start;
        } else if (*delalloc_end_ret + 1 == oe_start) {
                *delalloc_end_ret = oe_end;
        }

        return true;
}

/*
 * Check if there's delalloc in a given range.
 *
 * @inode:               The inode.
 * @start:               The start offset of the range. It does not need to be
 *                       sector size aligned.
 * @end:                 The end offset (inclusive value) of the search range.
 *                       It does not need to be sector size aligned.
 * @cached_state:        Extent state record used for speeding up delalloc
 *                       searches in the inode's io_tree. Can be NULL.
 * @delalloc_start_ret:  Output argument, set to the start offset of the
 *                       subrange found with delalloc (may not be sector size
 *                       aligned).
 * @delalloc_end_ret:    Output argument, set to he end offset (inclusive value)
 *                       of the subrange found with delalloc.
 *
 * Returns true if a subrange with delalloc is found within the given range, and
 * if so it sets @delalloc_start_ret and @delalloc_end_ret with the start and
 * end offsets of the subrange.
 */
bool btrfs_find_delalloc_in_range(struct btrfs_inode *inode, u64 start, u64 end,
                                  struct extent_state **cached_state,
                                  u64 *delalloc_start_ret, u64 *delalloc_end_ret)
{
        u64 cur_offset = round_down(start, inode->root->fs_info->sectorsize);
        u64 prev_delalloc_end = 0;
        bool search_io_tree = true;
        bool ret = false;

        while (cur_offset <= end) {
                u64 delalloc_start;
                u64 delalloc_end;
                bool delalloc;

                delalloc = find_delalloc_subrange(inode, cur_offset, end,
                                                  cached_state, &search_io_tree,
                                                  &delalloc_start,
                                                  &delalloc_end);
                if (!delalloc)
                        break;

                if (prev_delalloc_end == 0) {
                        /* First subrange found. */
                        *delalloc_start_ret = max(delalloc_start, start);
                        *delalloc_end_ret = delalloc_end;
                        ret = true;
                } else if (delalloc_start == prev_delalloc_end + 1) {
                        /* Subrange adjacent to the previous one, merge them. */
                        *delalloc_end_ret = delalloc_end;
                } else {
                        /* Subrange not adjacent to the previous one, exit. */
                        break;
                }

                prev_delalloc_end = delalloc_end;
                cur_offset = delalloc_end + 1;
                cond_resched();
        }

        return ret;
}

/*
 * Check if there's a hole or delalloc range in a range representing a hole (or
 * prealloc extent) found in the inode's subvolume btree.
 *
 * @inode:      The inode.
 * @whence:     Seek mode (SEEK_DATA or SEEK_HOLE).
 * @start:      Start offset of the hole region. It does not need to be sector
 *              size aligned.
 * @end:        End offset (inclusive value) of the hole region. It does not
 *              need to be sector size aligned.
 * @start_ret:  Return parameter, used to set the start of the subrange in the
 *              hole that matches the search criteria (seek mode), if such
 *              subrange is found (return value of the function is true).
 *              The value returned here may not be sector size aligned.
 *
 * Returns true if a subrange matching the given seek mode is found, and if one
 * is found, it updates @start_ret with the start of the subrange.
 */
static bool find_desired_extent_in_hole(struct btrfs_inode *inode, int whence,
                                        struct extent_state **cached_state,
                                        u64 start, u64 end, u64 *start_ret)
{
        u64 delalloc_start;
        u64 delalloc_end;
        bool delalloc;

        delalloc = btrfs_find_delalloc_in_range(inode, start, end, cached_state,
                                                &delalloc_start, &delalloc_end);
        if (delalloc && whence == SEEK_DATA) {
                *start_ret = delalloc_start;
                return true;
        }

        if (delalloc && whence == SEEK_HOLE) {
                /*
                 * We found delalloc but it starts after out start offset. So we
                 * have a hole between our start offset and the delalloc start.
                 */
                if (start < delalloc_start) {
                        *start_ret = start;
                        return true;
                }
                /*
                 * Delalloc range starts at our start offset.
                 * If the delalloc range's length is smaller than our range,
                 * then it means we have a hole that starts where the delalloc
                 * subrange ends.
                 */
                if (delalloc_end < end) {
                        *start_ret = delalloc_end + 1;
                        return true;
                }

                /* There's delalloc for the whole range. */
                return false;
        }

        if (!delalloc && whence == SEEK_HOLE) {
                *start_ret = start;
                return true;
        }

        /*
         * No delalloc in the range and we are seeking for data. The caller has
         * to iterate to the next extent item in the subvolume btree.
         */
        return false;
}

static loff_t find_desired_extent(struct file *file, loff_t offset, int whence)
{
        struct btrfs_inode *inode = BTRFS_I(file->f_mapping->host);
        struct btrfs_file_private *private;
        struct btrfs_fs_info *fs_info = inode->root->fs_info;
        struct extent_state *cached_state = NULL;
        struct extent_state **delalloc_cached_state;
        const loff_t i_size = i_size_read(&inode->vfs_inode);
        const u64 ino = btrfs_ino(inode);
        struct btrfs_root *root = inode->root;
        struct btrfs_path *path;
        struct btrfs_key key;
        u64 last_extent_end;
        u64 lockstart;
        u64 lockend;
        u64 start;
        int ret;
        bool found = false;

        if (i_size == 0 || offset >= i_size)
                return -ENXIO;

        /*
         * Quick path. If the inode has no prealloc extents and its number of
         * bytes used matches its i_size, then it can not have holes.
         */
        if (whence == SEEK_HOLE &&
            !(inode->flags & BTRFS_INODE_PREALLOC) &&
            inode_get_bytes(&inode->vfs_inode) == i_size)
                return i_size;

        spin_lock(&inode->lock);
        private = file->private_data;
        spin_unlock(&inode->lock);

        if (private && private->owner_task != current) {
                /*
                 * Not allocated by us, don't use it as its cached state is used
                 * by the task that allocated it and we don't want neither to
                 * mess with it nor get incorrect results because it reflects an
                 * invalid state for the current task.
                 */
                private = NULL;
        } else if (!private) {
                private = kzalloc_obj(*private);
                /*
                 * No worries if memory allocation failed.
                 * The private structure is used only for speeding up multiple
                 * lseek SEEK_HOLE/DATA calls to a file when there's delalloc,
                 * so everything will still be correct.
                 */
                if (private) {
                        bool free = false;

                        private->owner_task = current;

                        spin_lock(&inode->lock);
                        if (file->private_data)
                                free = true;
                        else
                                file->private_data = private;
                        spin_unlock(&inode->lock);

                        if (free) {
                                kfree(private);
                                private = NULL;
                        }
                }
        }

        if (private)
                delalloc_cached_state = &private->llseek_cached_state;
        else
                delalloc_cached_state = NULL;

        /*
         * offset can be negative, in this case we start finding DATA/HOLE from
         * the very start of the file.
         */
        start = max_t(loff_t, 0, offset);

        lockstart = round_down(start, fs_info->sectorsize);
        lockend = round_up(i_size, fs_info->sectorsize);
        if (lockend <= lockstart)
                lockend = lockstart + fs_info->sectorsize;
        lockend--;

        path = btrfs_alloc_path();
        if (!path)
                return -ENOMEM;
        path->reada = READA_FORWARD;

        key.objectid = ino;
        key.type = BTRFS_EXTENT_DATA_KEY;
        key.offset = start;

        last_extent_end = lockstart;

        btrfs_lock_extent(&inode->io_tree, lockstart, lockend, &cached_state);

        ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
        if (ret < 0) {
                goto out;
        } else if (ret > 0 && path->slots[0] > 0) {
                btrfs_item_key_to_cpu(path->nodes[0], &key, path->slots[0] - 1);
                if (key.objectid == ino && key.type == BTRFS_EXTENT_DATA_KEY)
                        path->slots[0]--;
        }

        while (start < i_size) {
                struct extent_buffer *leaf = path->nodes[0];
                struct btrfs_file_extent_item *extent;
                u64 extent_end;
                u8 type;

                if (path->slots[0] >= btrfs_header_nritems(leaf)) {
                        ret = btrfs_next_leaf(root, path);
                        if (ret < 0)
                                goto out;
                        else if (ret > 0)
                                break;

                        leaf = path->nodes[0];
                }

                btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
                if (key.objectid != ino || key.type != BTRFS_EXTENT_DATA_KEY)
                        break;

                extent_end = btrfs_file_extent_end(path);

                /*
                 * In the first iteration we may have a slot that points to an
                 * extent that ends before our start offset, so skip it.
                 */
                if (extent_end <= start) {
                        path->slots[0]++;
                        continue;
                }

                /* We have an implicit hole, NO_HOLES feature is likely set. */
                if (last_extent_end < key.offset) {
                        u64 search_start = last_extent_end;
                        u64 found_start;

                        /*
                         * First iteration, @start matches @offset and it's
                         * within the hole.
                         */
                        if (start == offset)
                                search_start = offset;

                        found = find_desired_extent_in_hole(inode, whence,
                                                            delalloc_cached_state,
                                                            search_start,
                                                            key.offset - 1,
                                                            &found_start);
                        if (found) {
                                start = found_start;
                                break;
                        }
                        /*
                         * Didn't find data or a hole (due to delalloc) in the
                         * implicit hole range, so need to analyze the extent.
                         */
                }

                extent = btrfs_item_ptr(leaf, path->slots[0],
                                        struct btrfs_file_extent_item);
                type = btrfs_file_extent_type(leaf, extent);

                /*
                 * Can't access the extent's disk_bytenr field if this is an
                 * inline extent, since at that offset, it's where the extent
                 * data starts.
                 */
                if (type == BTRFS_FILE_EXTENT_PREALLOC ||
                    (type == BTRFS_FILE_EXTENT_REG &&
                     btrfs_file_extent_disk_bytenr(leaf, extent) == 0)) {
                        /*
                         * Explicit hole or prealloc extent, search for delalloc.
                         * A prealloc extent is treated like a hole.
                         */
                        u64 search_start = key.offset;
                        u64 found_start;

                        /*
                         * First iteration, @start matches @offset and it's
                         * within the hole.
                         */
                        if (start == offset)
                                search_start = offset;

                        found = find_desired_extent_in_hole(inode, whence,
                                                            delalloc_cached_state,
                                                            search_start,
                                                            extent_end - 1,
                                                            &found_start);
                        if (found) {
                                start = found_start;
                                break;
                        }
                        /*
                         * Didn't find data or a hole (due to delalloc) in the
                         * implicit hole range, so need to analyze the next
                         * extent item.
                         */
                } else {
                        /*
                         * Found a regular or inline extent.
                         * If we are seeking for data, adjust the start offset
                         * and stop, we're done.
                         */
                        if (whence == SEEK_DATA) {
                                start = max_t(u64, key.offset, offset);
                                found = true;
                                break;
                        }
                        /*
                         * Else, we are seeking for a hole, check the next file
                         * extent item.
                         */
                }

                start = extent_end;
                last_extent_end = extent_end;
                path->slots[0]++;
                if (fatal_signal_pending(current)) {
                        ret = -EINTR;
                        goto out;
                }
                cond_resched();
        }

        /* We have an implicit hole from the last extent found up to i_size. */
        if (!found && start < i_size) {
                found = find_desired_extent_in_hole(inode, whence,
                                                    delalloc_cached_state, start,
                                                    i_size - 1, &start);
                if (!found)
                        start = i_size;
        }

out:
        btrfs_unlock_extent(&inode->io_tree, lockstart, lockend, &cached_state);
        btrfs_free_path(path);

        if (ret < 0)
                return ret;

        if (whence == SEEK_DATA && start >= i_size)
                return -ENXIO;

        return min_t(loff_t, start, i_size);
}

static loff_t btrfs_file_llseek(struct file *file, loff_t offset, int whence)
{
        struct inode *inode = file->f_mapping->host;

        switch (whence) {
        default:
                return generic_file_llseek(file, offset, whence);
        case SEEK_DATA:
        case SEEK_HOLE:
                btrfs_inode_lock(BTRFS_I(inode), BTRFS_ILOCK_SHARED);
                offset = find_desired_extent(file, offset, whence);
                btrfs_inode_unlock(BTRFS_I(inode), BTRFS_ILOCK_SHARED);
                break;
        }

        if (offset < 0)
                return offset;

        return vfs_setpos(file, offset, inode->i_sb->s_maxbytes);
}

static int btrfs_file_open(struct inode *inode, struct file *filp)
{
        int ret;

        if (btrfs_is_shutdown(inode_to_fs_info(inode)))
                return -EIO;

        filp->f_mode |= FMODE_NOWAIT | FMODE_CAN_ODIRECT;

        ret = fsverity_file_open(inode, filp);
        if (ret)
                return ret;
        return generic_file_open(inode, filp);
}

static ssize_t btrfs_file_read_iter(struct kiocb *iocb, struct iov_iter *to)
{
        ssize_t ret = 0;

        if (btrfs_is_shutdown(inode_to_fs_info(file_inode(iocb->ki_filp))))
                return -EIO;

        if (iocb->ki_flags & IOCB_DIRECT) {
                ret = btrfs_direct_read(iocb, to);
                if (ret < 0 || !iov_iter_count(to) ||
                    iocb->ki_pos >= i_size_read(file_inode(iocb->ki_filp)))
                        return ret;
        }

        return filemap_read(iocb, to, ret);
}

static ssize_t btrfs_file_splice_read(struct file *in, loff_t *ppos,
                                      struct pipe_inode_info *pipe,
                                      size_t len, unsigned int flags)
{
        if (btrfs_is_shutdown(inode_to_fs_info(file_inode(in))))
                return -EIO;

        return filemap_splice_read(in, ppos, pipe, len, flags);
}

const struct file_operations btrfs_file_operations = {
        .llseek                = btrfs_file_llseek,
        .read_iter      = btrfs_file_read_iter,
        .splice_read        = btrfs_file_splice_read,
        .write_iter        = btrfs_file_write_iter,
        .splice_write        = iter_file_splice_write,
        .mmap_prepare        = btrfs_file_mmap_prepare,
        .open                = btrfs_file_open,
        .release        = btrfs_release_file,
        .get_unmapped_area = thp_get_unmapped_area,
        .fsync                = btrfs_sync_file,
        .fallocate        = btrfs_fallocate,
        .unlocked_ioctl        = btrfs_ioctl,
#ifdef CONFIG_COMPAT
        .compat_ioctl        = btrfs_compat_ioctl,
#endif
        .remap_file_range = btrfs_remap_file_range,
        .uring_cmd        = btrfs_uring_cmd,
        .fop_flags        = FOP_BUFFER_RASYNC | FOP_BUFFER_WASYNC,
        .setlease        = generic_setlease,
};

int btrfs_fdatawrite_range(struct btrfs_inode *inode, loff_t start, loff_t end)
{
        struct address_space *mapping = inode->vfs_inode.i_mapping;
        int ret;

        /*
         * So with compression we will find and lock a dirty page and clear the
         * first one as dirty, setup an async extent, and immediately return
         * with the entire range locked but with nobody actually marked with
         * writeback.  So we can't just filemap_write_and_wait_range() and
         * expect it to work since it will just kick off a thread to do the
         * actual work.  So we need to call filemap_fdatawrite_range _again_
         * since it will wait on the page lock, which won't be unlocked until
         * after the pages have been marked as writeback and so we're good to go
         * from there.  We have to do this otherwise we'll miss the ordered
         * extents and that results in badness.  Please Josef, do not think you
         * know better and pull this out at some point in the future, it is
         * right and you are wrong.
         */
        ret = filemap_fdatawrite_range(mapping, start, end);
        if (!ret && test_bit(BTRFS_INODE_HAS_ASYNC_EXTENT, &inode->runtime_flags))
                ret = filemap_fdatawrite_range(mapping, start, end);

        return ret;
}




























































































































































































































































































































































































































































































































































































































































    9 




    9 















    9 






































































































































































































































































































































































































































































































































































































































































































































































































































































    7 
























    7 


    6 
    7 






























































































    7 

    2 
    7 
    7 







































    7 







    7 




























































































































































































































































































    2 

















































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
// SPDX-License-Identifier: GPL-2.0-only
/*
 * scan.c - support for transforming the ACPI namespace into individual objects
 */

#define pr_fmt(fmt) "ACPI: " fmt

#include <linux/async.h>
#include <linux/auxiliary_bus.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/kernel.h>
#include <linux/acpi.h>
#include <linux/acpi_iort.h>
#include <linux/acpi_rimt.h>
#include <linux/acpi_viot.h>
#include <linux/iommu.h>
#include <linux/signal.h>
#include <linux/kthread.h>
#include <linux/dmi.h>
#include <linux/dma-map-ops.h>
#include <linux/platform_data/x86/apple.h>
#include <linux/pgtable.h>
#include <linux/crc32.h>
#include <linux/dma-direct.h>

#include "internal.h"
#include "sleep.h"

#define ACPI_BUS_CLASS                        "system_bus"
#define ACPI_BUS_HID                        "LNXSYBUS"
#define ACPI_BUS_DEVICE_NAME                "System Bus"

#define INVALID_ACPI_HANDLE        ((acpi_handle)ZERO_PAGE(0))

static const char *dummy_hid = "device";

static LIST_HEAD(acpi_dep_list);
static DEFINE_MUTEX(acpi_dep_list_lock);
LIST_HEAD(acpi_bus_id_list);
static DEFINE_MUTEX(acpi_scan_lock);
static LIST_HEAD(acpi_scan_handlers_list);
DEFINE_MUTEX(acpi_device_lock);
LIST_HEAD(acpi_wakeup_device_list);
static DEFINE_MUTEX(acpi_hp_context_lock);
static LIST_HEAD(acpi_scan_system_dev_list);

/*
 * The UART device described by the SPCR table is the only object which needs
 * special-casing. Everything else is covered by ACPI namespace paths in STAO
 * table.
 */
static u64 spcr_uart_addr;

void acpi_scan_lock_acquire(void)
{
        mutex_lock(&acpi_scan_lock);
}
EXPORT_SYMBOL_GPL(acpi_scan_lock_acquire);

void acpi_scan_lock_release(void)
{
        mutex_unlock(&acpi_scan_lock);
}
EXPORT_SYMBOL_GPL(acpi_scan_lock_release);

void acpi_lock_hp_context(void)
{
        mutex_lock(&acpi_hp_context_lock);
}

void acpi_unlock_hp_context(void)
{
        mutex_unlock(&acpi_hp_context_lock);
}

void acpi_initialize_hp_context(struct acpi_device *adev,
                                struct acpi_hotplug_context *hp,
                                acpi_hp_notify notify, acpi_hp_uevent uevent)
{
        acpi_lock_hp_context();
        hp->notify = notify;
        hp->uevent = uevent;
        acpi_set_hp_context(adev, hp);
        acpi_unlock_hp_context();
}
EXPORT_SYMBOL_GPL(acpi_initialize_hp_context);

int acpi_scan_add_handler(struct acpi_scan_handler *handler)
{
        if (!handler)
                return -EINVAL;

        list_add_tail(&handler->list_node, &acpi_scan_handlers_list);
        return 0;
}

int acpi_scan_add_handler_with_hotplug(struct acpi_scan_handler *handler,
                                       const char *hotplug_profile_name)
{
        int error;

        error = acpi_scan_add_handler(handler);
        if (error)
                return error;

        acpi_sysfs_add_hotplug_profile(&handler->hotplug, hotplug_profile_name);
        return 0;
}

bool acpi_scan_is_offline(struct acpi_device *adev, bool uevent)
{
        struct acpi_device_physical_node *pn;
        bool offline = true;
        char *envp[] = { "EVENT=offline", NULL };

        /*
         * acpi_container_offline() calls this for all of the container's
         * children under the container's physical_node_lock lock.
         */
        mutex_lock_nested(&adev->physical_node_lock, SINGLE_DEPTH_NESTING);

        list_for_each_entry(pn, &adev->physical_node_list, node)
                if (device_supports_offline(pn->dev) && !dev_offline(pn->dev)) {
                        if (uevent)
                                kobject_uevent_env(&pn->dev->kobj, KOBJ_CHANGE, envp);

                        offline = false;
                        break;
                }

        mutex_unlock(&adev->physical_node_lock);
        return offline;
}

static acpi_status acpi_bus_offline(acpi_handle handle, u32 lvl, void *data,
                                    void **ret_p)
{
        struct acpi_device *device = acpi_fetch_acpi_dev(handle);
        struct acpi_device_physical_node *pn;
        bool second_pass = (bool)data;
        acpi_status status = AE_OK;

        if (!device)
                return AE_OK;

        if (device->handler && !device->handler->hotplug.enabled) {
                *ret_p = &device->dev;
                return AE_SUPPORT;
        }

        mutex_lock(&device->physical_node_lock);

        list_for_each_entry(pn, &device->physical_node_list, node) {
                int ret;

                if (second_pass) {
                        /* Skip devices offlined by the first pass. */
                        if (pn->put_online)
                                continue;
                } else {
                        pn->put_online = false;
                }
                ret = device_offline(pn->dev);
                if (ret >= 0) {
                        pn->put_online = !ret;
                } else {
                        *ret_p = pn->dev;
                        if (second_pass) {
                                status = AE_ERROR;
                                break;
                        }
                }
        }

        mutex_unlock(&device->physical_node_lock);

        return status;
}

static acpi_status acpi_bus_online(acpi_handle handle, u32 lvl, void *data,
                                   void **ret_p)
{
        struct acpi_device *device = acpi_fetch_acpi_dev(handle);
        struct acpi_device_physical_node *pn;

        if (!device)
                return AE_OK;

        mutex_lock(&device->physical_node_lock);

        list_for_each_entry(pn, &device->physical_node_list, node)
                if (pn->put_online) {
                        device_online(pn->dev);
                        pn->put_online = false;
                }

        mutex_unlock(&device->physical_node_lock);

        return AE_OK;
}

static int acpi_scan_try_to_offline(struct acpi_device *device)
{
        acpi_handle handle = device->handle;
        struct device *errdev = NULL;
        acpi_status status;

        /*
         * Carry out two passes here and ignore errors in the first pass,
         * because if the devices in question are memory blocks and
         * CONFIG_MEMCG is set, one of the blocks may hold data structures
         * that the other blocks depend on, but it is not known in advance which
         * block holds them.
         *
         * If the first pass is successful, the second one isn't needed, though.
         */
        status = acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
                                     NULL, acpi_bus_offline, (void *)false,
                                     (void **)&errdev);
        if (status == AE_SUPPORT) {
                dev_warn(errdev, "Offline disabled.\n");
                acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
                                    acpi_bus_online, NULL, NULL, NULL);
                return -EPERM;
        }
        acpi_bus_offline(handle, 0, (void *)false, (void **)&errdev);
        if (errdev) {
                errdev = NULL;
                acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
                                    NULL, acpi_bus_offline, (void *)true,
                                    (void **)&errdev);
                if (!errdev)
                        acpi_bus_offline(handle, 0, (void *)true,
                                         (void **)&errdev);

                if (errdev) {
                        dev_warn(errdev, "Offline failed.\n");
                        acpi_bus_online(handle, 0, NULL, NULL);
                        acpi_walk_namespace(ACPI_TYPE_ANY, handle,
                                            ACPI_UINT32_MAX, acpi_bus_online,
                                            NULL, NULL, NULL);
                        return -EBUSY;
                }
        }
        return 0;
}

#define ACPI_SCAN_CHECK_FLAG_STATUS        BIT(0)
#define ACPI_SCAN_CHECK_FLAG_EJECT        BIT(1)

static int acpi_scan_check_and_detach(struct acpi_device *adev, void *p)
{
        struct acpi_scan_handler *handler = adev->handler;
        uintptr_t flags = (uintptr_t)p;

        acpi_dev_for_each_child_reverse(adev, acpi_scan_check_and_detach, p);

        if (flags & ACPI_SCAN_CHECK_FLAG_STATUS) {
                acpi_bus_get_status(adev);
                /*
                 * Skip devices that are still there and take the enabled
                 * flag into account.
                 */
                if (acpi_device_is_enabled(adev))
                        return 0;

                /* Skip device that have not been enumerated. */
                if (!acpi_device_enumerated(adev)) {
                        dev_dbg(&adev->dev, "Still not enumerated\n");
                        return 0;
                }
        }

        adev->flags.match_driver = false;
        if (handler) {
                if (handler->detach)
                        handler->detach(adev);
        } else {
                device_release_driver(&adev->dev);
        }
        /*
         * Most likely, the device is going away, so put it into D3cold before
         * that.
         */
        acpi_device_set_power(adev, ACPI_STATE_D3_COLD);
        adev->flags.initialized = false;

        /* For eject this is deferred to acpi_bus_post_eject() */
        if (!(flags & ACPI_SCAN_CHECK_FLAG_EJECT)) {
                adev->handler = NULL;
                acpi_device_clear_enumerated(adev);
        }
        return 0;
}

static int acpi_bus_post_eject(struct acpi_device *adev, void *not_used)
{
        struct acpi_scan_handler *handler = adev->handler;

        acpi_dev_for_each_child_reverse(adev, acpi_bus_post_eject, NULL);

        if (handler) {
                if (handler->post_eject)
                        handler->post_eject(adev);

                adev->handler = NULL;
        }

        acpi_device_clear_enumerated(adev);

        return 0;
}

static void acpi_scan_check_subtree(struct acpi_device *adev)
{
        uintptr_t flags = ACPI_SCAN_CHECK_FLAG_STATUS;

        acpi_scan_check_and_detach(adev, (void *)flags);
}

static int acpi_scan_hot_remove(struct acpi_device *device)
{
        acpi_handle handle = device->handle;
        unsigned long long sta;
        acpi_status status;
        uintptr_t flags = ACPI_SCAN_CHECK_FLAG_EJECT;

        if (device->handler && device->handler->hotplug.demand_offline) {
                if (!acpi_scan_is_offline(device, true))
                        return -EBUSY;
        } else {
                int error = acpi_scan_try_to_offline(device);
                if (error)
                        return error;
        }

        acpi_handle_debug(handle, "Ejecting\n");

        acpi_scan_check_and_detach(device, (void *)flags);

        acpi_evaluate_lck(handle, 0);
        /*
         * TBD: _EJD support.
         */
        status = acpi_evaluate_ej0(handle);
        if (status == AE_NOT_FOUND)
                return -ENODEV;
        else if (ACPI_FAILURE(status))
                return -EIO;

        /*
         * Verify if eject was indeed successful.  If not, log an error
         * message.  No need to call _OST since _EJ0 call was made OK.
         */
        status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
        if (ACPI_FAILURE(status)) {
                acpi_handle_warn(handle,
                        "Status check after eject failed (0x%x)\n", status);
        } else if (sta & ACPI_STA_DEVICE_ENABLED) {
                acpi_handle_warn(handle,
                        "Eject incomplete - status 0x%llx\n", sta);
        } else {
                acpi_bus_post_eject(device, NULL);
        }

        return 0;
}

static int acpi_scan_rescan_bus(struct acpi_device *adev)
{
        struct acpi_scan_handler *handler = adev->handler;
        int ret;

        if (handler && handler->hotplug.scan_dependent)
                ret = handler->hotplug.scan_dependent(adev);
        else
                ret = acpi_bus_scan(adev->handle);

        if (ret)
                dev_info(&adev->dev, "Namespace scan failure\n");

        return ret;
}

static int acpi_scan_device_check(struct acpi_device *adev)
{
        struct acpi_device *parent;

        acpi_scan_check_subtree(adev);

        if (!acpi_device_is_present(adev))
                return 0;

        /*
         * This function is only called for device objects for which matching
         * scan handlers exist.  The only situation in which the scan handler
         * is not attached to this device object yet is when the device has
         * just appeared (either it wasn't present at all before or it was
         * removed and then added again).
         */
        if (adev->handler) {
                dev_dbg(&adev->dev, "Already enumerated\n");
                return 0;
        }

        parent = acpi_dev_parent(adev);
        if (!parent)
                parent = adev;

        return acpi_scan_rescan_bus(parent);
}

static int acpi_scan_bus_check(struct acpi_device *adev)
{
        acpi_scan_check_subtree(adev);

        return acpi_scan_rescan_bus(adev);
}

static int acpi_generic_hotplug_event(struct acpi_device *adev, u32 type)
{
        switch (type) {
        case ACPI_NOTIFY_BUS_CHECK:
                return acpi_scan_bus_check(adev);
        case ACPI_NOTIFY_DEVICE_CHECK:
                return acpi_scan_device_check(adev);
        case ACPI_NOTIFY_EJECT_REQUEST:
        case ACPI_OST_EC_OSPM_EJECT:
                if (adev->handler && !adev->handler->hotplug.enabled) {
                        dev_info(&adev->dev, "Eject disabled\n");
                        return -EPERM;
                }
                acpi_evaluate_ost(adev->handle, ACPI_NOTIFY_EJECT_REQUEST,
                                  ACPI_OST_SC_EJECT_IN_PROGRESS, NULL);
                return acpi_scan_hot_remove(adev);
        }
        return -EINVAL;
}

void acpi_device_hotplug(struct acpi_device *adev, u32 src)
{
        u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
        int error = -ENODEV;

        lock_device_hotplug();
        mutex_lock(&acpi_scan_lock);

        /*
         * The device object's ACPI handle cannot become invalid as long as we
         * are holding acpi_scan_lock, but it might have become invalid before
         * that lock was acquired.
         */
        if (adev->handle == INVALID_ACPI_HANDLE)
                goto err_out;

        if (adev->flags.is_dock_station) {
                error = dock_notify(adev, src);
        } else if (adev->flags.hotplug_notify) {
                error = acpi_generic_hotplug_event(adev, src);
        } else {
                acpi_hp_notify notify;

                acpi_lock_hp_context();
                notify = adev->hp ? adev->hp->notify : NULL;
                acpi_unlock_hp_context();
                /*
                 * There may be additional notify handlers for device objects
                 * without the .event() callback, so ignore them here.
                 */
                if (notify)
                        error = notify(adev, src);
                else
                        goto out;
        }
        switch (error) {
        case 0:
                ost_code = ACPI_OST_SC_SUCCESS;
                break;
        case -EPERM:
                ost_code = ACPI_OST_SC_EJECT_NOT_SUPPORTED;
                break;
        case -EBUSY:
                ost_code = ACPI_OST_SC_DEVICE_BUSY;
                break;
        default:
                ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
                break;
        }

 err_out:
        acpi_evaluate_ost(adev->handle, src, ost_code, NULL);

 out:
        acpi_put_acpi_dev(adev);
        mutex_unlock(&acpi_scan_lock);
        unlock_device_hotplug();
}

static void acpi_free_power_resources_lists(struct acpi_device *device)
{
        int i;

        if (device->wakeup.flags.valid)
                acpi_power_resources_list_free(&device->wakeup.resources);

        if (!device->power.flags.power_resources)
                return;

        for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
                struct acpi_device_power_state *ps = &device->power.states[i];
                acpi_power_resources_list_free(&ps->resources);
        }
}

static void acpi_device_release(struct device *dev)
{
        struct acpi_device *acpi_dev = to_acpi_device(dev);

        acpi_free_properties(acpi_dev);
        acpi_free_pnp_ids(&acpi_dev->pnp);
        acpi_free_power_resources_lists(acpi_dev);
        kfree(acpi_dev);
}

static void acpi_device_del(struct acpi_device *device)
{
        struct acpi_device_bus_id *acpi_device_bus_id;

        mutex_lock(&acpi_device_lock);

        list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
                if (!strcmp(acpi_device_bus_id->bus_id,
                            acpi_device_hid(device))) {
                        ida_free(&acpi_device_bus_id->instance_ida,
                                 device->pnp.instance_no);
                        if (ida_is_empty(&acpi_device_bus_id->instance_ida)) {
                                list_del(&acpi_device_bus_id->node);
                                kfree_const(acpi_device_bus_id->bus_id);
                                kfree(acpi_device_bus_id);
                        }
                        break;
                }

        list_del(&device->wakeup_list);

        mutex_unlock(&acpi_device_lock);

        acpi_power_add_remove_device(device, false);
        acpi_device_remove_files(device);
        if (device->remove)
                device->remove(device);

        device_del(&device->dev);
}

static BLOCKING_NOTIFIER_HEAD(acpi_reconfig_chain);

static LIST_HEAD(acpi_device_del_list);
static DEFINE_MUTEX(acpi_device_del_lock);

static void acpi_device_del_work_fn(struct work_struct *work_not_used)
{
        for (;;) {
                struct acpi_device *adev;

                mutex_lock(&acpi_device_del_lock);

                if (list_empty(&acpi_device_del_list)) {
                        mutex_unlock(&acpi_device_del_lock);
                        break;
                }
                adev = list_first_entry(&acpi_device_del_list,
                                        struct acpi_device, del_list);
                list_del(&adev->del_list);

                mutex_unlock(&acpi_device_del_lock);

                blocking_notifier_call_chain(&acpi_reconfig_chain,
                                             ACPI_RECONFIG_DEVICE_REMOVE, adev);

                acpi_device_del(adev);
                /*
                 * Drop references to all power resources that might have been
                 * used by the device.
                 */
                acpi_power_transition(adev, ACPI_STATE_D3_COLD);
                acpi_dev_put(adev);
        }
}

/**
 * acpi_scan_drop_device - Drop an ACPI device object.
 * @handle: Handle of an ACPI namespace node, not used.
 * @context: Address of the ACPI device object to drop.
 *
 * This is invoked by acpi_ns_delete_node() during the removal of the ACPI
 * namespace node the device object pointed to by @context is attached to.
 *
 * The unregistration is carried out asynchronously to avoid running
 * acpi_device_del() under the ACPICA's namespace mutex and the list is used to
 * ensure the correct ordering (the device objects must be unregistered in the
 * same order in which the corresponding namespace nodes are deleted).
 */
static void acpi_scan_drop_device(acpi_handle handle, void *context)
{
        static DECLARE_WORK(work, acpi_device_del_work_fn);
        struct acpi_device *adev = context;

        mutex_lock(&acpi_device_del_lock);

        /*
         * Use the ACPI hotplug workqueue which is ordered, so this work item
         * won't run after any hotplug work items submitted subsequently.  That
         * prevents attempts to register device objects identical to those being
         * deleted from happening concurrently (such attempts result from
         * hotplug events handled via the ACPI hotplug workqueue).  It also will
         * run after all of the work items submitted previously, which helps
         * those work items to ensure that they are not accessing stale device
         * objects.
         */
        if (list_empty(&acpi_device_del_list))
                acpi_queue_hotplug_work(&work);

        list_add_tail(&adev->del_list, &acpi_device_del_list);
        /* Make acpi_ns_validate_handle() return NULL for this handle. */
        adev->handle = INVALID_ACPI_HANDLE;

        mutex_unlock(&acpi_device_del_lock);
}

static struct acpi_device *handle_to_device(acpi_handle handle,
                                            void (*callback)(void *))
{
        struct acpi_device *adev = NULL;
        acpi_status status;

        status = acpi_get_data_full(handle, acpi_scan_drop_device,
                                    (void **)&adev, callback);
        if (ACPI_FAILURE(status) || !adev) {
                acpi_handle_debug(handle, "No context!\n");
                return NULL;
        }
        return adev;
}

/**
 * acpi_fetch_acpi_dev - Retrieve ACPI device object.
 * @handle: ACPI handle associated with the requested ACPI device object.
 *
 * Return a pointer to the ACPI device object associated with @handle, if
 * present, or NULL otherwise.
 */
struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle)
{
        return handle_to_device(handle, NULL);
}
EXPORT_SYMBOL_GPL(acpi_fetch_acpi_dev);

static void get_acpi_device(void *dev)
{
        acpi_dev_get(dev);
}

/**
 * acpi_get_acpi_dev - Retrieve ACPI device object and reference count it.
 * @handle: ACPI handle associated with the requested ACPI device object.
 *
 * Return a pointer to the ACPI device object associated with @handle and bump
 * up that object's reference counter (under the ACPI Namespace lock), if
 * present, or return NULL otherwise.
 *
 * The ACPI device object reference acquired by this function needs to be
 * dropped via acpi_dev_put().
 */
struct acpi_device *acpi_get_acpi_dev(acpi_handle handle)
{
        return handle_to_device(handle, get_acpi_device);
}
EXPORT_SYMBOL_GPL(acpi_get_acpi_dev);

static struct acpi_device_bus_id *acpi_device_bus_id_match(const char *dev_id)
{
        struct acpi_device_bus_id *acpi_device_bus_id;

        /* Find suitable bus_id and instance number in acpi_bus_id_list. */
        list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
                if (!strcmp(acpi_device_bus_id->bus_id, dev_id))
                        return acpi_device_bus_id;
        }
        return NULL;
}

static int acpi_device_set_name(struct acpi_device *device,
                                struct acpi_device_bus_id *acpi_device_bus_id)
{
        struct ida *instance_ida = &acpi_device_bus_id->instance_ida;
        int result;

        result = ida_alloc(instance_ida, GFP_KERNEL);
        if (result < 0)
                return result;

        device->pnp.instance_no = result;
        dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, result);
        return 0;
}

int acpi_tie_acpi_dev(struct acpi_device *adev)
{
        acpi_handle handle = adev->handle;
        acpi_status status;

        if (!handle)
                return 0;

        status = acpi_attach_data(handle, acpi_scan_drop_device, adev);
        if (ACPI_FAILURE(status)) {
                acpi_handle_err(handle, "Unable to attach device data\n");
                return -ENODEV;
        }

        return 0;
}

static void acpi_store_pld_crc(struct acpi_device *adev)
{
        struct acpi_pld_info *pld;

        if (!acpi_get_physical_device_location(adev->handle, &pld))
                return;

        adev->pld_crc = crc32(~0, pld, sizeof(*pld));
        ACPI_FREE(pld);
}

int acpi_device_add(struct acpi_device *device)
{
        struct acpi_device_bus_id *acpi_device_bus_id;
        int result;

        /*
         * Linkage
         * -------
         * Link this device to its parent and siblings.
         */
        INIT_LIST_HEAD(&device->wakeup_list);
        INIT_LIST_HEAD(&device->physical_node_list);
        INIT_LIST_HEAD(&device->del_list);
        mutex_init(&device->physical_node_lock);

        mutex_lock(&acpi_device_lock);

        acpi_device_bus_id = acpi_device_bus_id_match(acpi_device_hid(device));
        if (acpi_device_bus_id) {
                result = acpi_device_set_name(device, acpi_device_bus_id);
                if (result)
                        goto err_unlock;
        } else {
                acpi_device_bus_id = kzalloc_obj(*acpi_device_bus_id);
                if (!acpi_device_bus_id) {
                        result = -ENOMEM;
                        goto err_unlock;
                }
                acpi_device_bus_id->bus_id =
                        kstrdup_const(acpi_device_hid(device), GFP_KERNEL);
                if (!acpi_device_bus_id->bus_id) {
                        kfree(acpi_device_bus_id);
                        result = -ENOMEM;
                        goto err_unlock;
                }

                ida_init(&acpi_device_bus_id->instance_ida);

                result = acpi_device_set_name(device, acpi_device_bus_id);
                if (result) {
                        kfree_const(acpi_device_bus_id->bus_id);
                        kfree(acpi_device_bus_id);
                        goto err_unlock;
                }

                list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
        }

        if (device->wakeup.flags.valid)
                list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);

        acpi_store_pld_crc(device);

        mutex_unlock(&acpi_device_lock);

        result = device_add(&device->dev);
        if (result) {
                dev_err(&device->dev, "Error registering device\n");
                goto err;
        }

        acpi_device_setup_files(device);

        return 0;

err:
        mutex_lock(&acpi_device_lock);

        list_del(&device->wakeup_list);

err_unlock:
        mutex_unlock(&acpi_device_lock);

        acpi_detach_data(device->handle, acpi_scan_drop_device);

        return result;
}

/* --------------------------------------------------------------------------
                                 Device Enumeration
   -------------------------------------------------------------------------- */
static bool acpi_info_matches_ids(struct acpi_device_info *info,
                                  const char * const ids[])
{
        struct acpi_pnp_device_id_list *cid_list = NULL;
        int i, index;

        if (!(info->valid & ACPI_VALID_HID))
                return false;

        index = match_string(ids, -1, info->hardware_id.string);
        if (index >= 0)
                return true;

        if (info->valid & ACPI_VALID_CID)
                cid_list = &info->compatible_id_list;

        if (!cid_list)
                return false;

        for (i = 0; i < cid_list->count; i++) {
                index = match_string(ids, -1, cid_list->ids[i].string);
                if (index >= 0)
                        return true;
        }

        return false;
}

/* List of HIDs for which we ignore matching ACPI devices, when checking _DEP lists. */
static const char * const acpi_ignore_dep_ids[] = {
        "PNP0D80", /* Windows-compatible System Power Management Controller */
        "INT33BD", /* Intel Baytrail Mailbox Device */
        "LATT2021", /* Lattice FW Update Client Driver */
        NULL
};

/* List of HIDs for which we honor deps of matching ACPI devs, when checking _DEP lists. */
static const char * const acpi_honor_dep_ids[] = {
        "INT3472", /* Camera sensor PMIC / clk and regulator info */
        "INTC1059", /* IVSC (TGL) driver must be loaded to allow i2c access to camera sensors */
        "INTC1095", /* IVSC (ADL) driver must be loaded to allow i2c access to camera sensors */
        "INTC100A", /* IVSC (RPL) driver must be loaded to allow i2c access to camera sensors */
        "INTC10CF", /* IVSC (MTL) driver must be loaded to allow i2c access to camera sensors */
        "INTC10DE", /* CVS (LNL) driver must be loaded to allow camera streaming */
        "INTC10E0", /* CVS (ARL) driver must be loaded to allow camera streaming */
        "INTC10E1", /* CVS (PTL) driver must be loaded to allow camera streaming */
        "RSCV0001", /* RISC-V PLIC */
        "RSCV0002", /* RISC-V APLIC */
        "RSCV0005", /* RISC-V SBI MPXY MBOX */
        "RSCV0006", /* RISC-V RPMI SYSMSI */
        "PNP0C0F",  /* PCI Link Device */
        "ACPI0016", /* CXL/PCIe host bridge: CXL root (ACPI0017) depends on PCI root attach */
        NULL
};

static struct acpi_device *acpi_find_parent_acpi_dev(acpi_handle handle)
{
        struct acpi_device *adev;

        /*
         * Fixed hardware devices do not appear in the namespace and do not
         * have handles, but we fabricate acpi_devices for them, so we have
         * to deal with them specially.
         */
        if (!handle)
                return acpi_root;

        do {
                acpi_status status;

                status = acpi_get_parent(handle, &handle);
                if (ACPI_FAILURE(status)) {
                        if (status != AE_NULL_ENTRY)
                                return acpi_root;

                        return NULL;
                }
                adev = acpi_fetch_acpi_dev(handle);
        } while (!adev);
        return adev;
}

acpi_status
acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
{
        acpi_status status;
        acpi_handle tmp;
        struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
        union acpi_object *obj;

        status = acpi_get_handle(handle, "_EJD", &tmp);
        if (ACPI_FAILURE(status))
                return status;

        status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
        if (ACPI_SUCCESS(status)) {
                obj = buffer.pointer;
                status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
                                         ejd);
                kfree(buffer.pointer);
        }
        return status;
}
EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);

static int acpi_bus_extract_wakeup_device_power_package(struct acpi_device *dev)
{
        acpi_handle handle = dev->handle;
        struct acpi_device_wakeup *wakeup = &dev->wakeup;
        struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
        union acpi_object *package = NULL;
        union acpi_object *element = NULL;
        acpi_status status;
        int err = -ENODATA;

        INIT_LIST_HEAD(&wakeup->resources);

        /* _PRW */
        status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
        if (ACPI_FAILURE(status)) {
                acpi_handle_info(handle, "_PRW evaluation failed: %s\n",
                                 acpi_format_exception(status));
                return err;
        }

        package = (union acpi_object *)buffer.pointer;

        if (!package || package->package.count < 2)
                goto out;

        element = &(package->package.elements[0]);
        if (!element)
                goto out;

        if (element->type == ACPI_TYPE_PACKAGE) {
                if ((element->package.count < 2) ||
                    (element->package.elements[0].type !=
                     ACPI_TYPE_LOCAL_REFERENCE)
                    || (element->package.elements[1].type != ACPI_TYPE_INTEGER))
                        goto out;

                wakeup->gpe_device =
                    element->package.elements[0].reference.handle;
                wakeup->gpe_number =
                    (u32) element->package.elements[1].integer.value;
        } else if (element->type == ACPI_TYPE_INTEGER) {
                wakeup->gpe_device = NULL;
                wakeup->gpe_number = element->integer.value;
        } else {
                goto out;
        }

        element = &(package->package.elements[1]);
        if (element->type != ACPI_TYPE_INTEGER)
                goto out;

        wakeup->sleep_state = element->integer.value;

        err = acpi_extract_power_resources(package, 2, &wakeup->resources);
        if (err)
                goto out;

        if (!list_empty(&wakeup->resources)) {
                int sleep_state;

                err = acpi_power_wakeup_list_init(&wakeup->resources,
                                                  &sleep_state);
                if (err) {
                        acpi_handle_warn(handle, "Retrieving current states "
                                         "of wakeup power resources failed\n");
                        acpi_power_resources_list_free(&wakeup->resources);
                        goto out;
                }
                if (sleep_state < wakeup->sleep_state) {
                        acpi_handle_warn(handle, "Overriding _PRW sleep state "
                                         "(S%d) by S%d from power resources\n",
                                         (int)wakeup->sleep_state, sleep_state);
                        wakeup->sleep_state = sleep_state;
                }
        }

 out:
        kfree(buffer.pointer);
        return err;
}

static bool acpi_wakeup_gpe_init(struct acpi_device *device)
{
        static const struct acpi_device_id button_device_ids[] = {
                {"PNP0C0D", 0},        /* Lid */
                {"PNP0C0E", 0},        /* Sleep button */
                {"", 0},
        };
        struct acpi_device_wakeup *wakeup = &device->wakeup;
        const struct acpi_device_id *match;
        acpi_status status;

        wakeup->flags.notifier_present = 0;

        match = acpi_match_acpi_device(button_device_ids, device);
        if (match && wakeup->sleep_state == ACPI_STATE_S5)
                wakeup->sleep_state = ACPI_STATE_S4;

        status = acpi_setup_gpe_for_wake(device->handle, wakeup->gpe_device,
                                         wakeup->gpe_number);
        return ACPI_SUCCESS(status);
}

static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
{
        int err;

        /* Presence of _PRW indicates wake capable */
        if (!acpi_has_method(device->handle, "_PRW"))
                return;

        err = acpi_bus_extract_wakeup_device_power_package(device);
        if (err) {
                dev_err(&device->dev, "Unable to extract wakeup power resources");
                return;
        }

        device->wakeup.flags.valid = acpi_wakeup_gpe_init(device);
        device->wakeup.prepare_count = 0;
        /*
         * Call _PSW/_DSW object to disable its ability to wake the sleeping
         * system for the ACPI device with the _PRW object.
         * The _PSW object is deprecated in ACPI 3.0 and is replaced by _DSW.
         * So it is necessary to call _DSW object first. Only when it is not
         * present will the _PSW object used.
         */
        err = acpi_device_sleep_wake(device, 0, 0, 0);
        if (err)
                pr_debug("error in _DSW or _PSW evaluation\n");
}

static void acpi_bus_init_power_state(struct acpi_device *device, int state)
{
        struct acpi_device_power_state *ps = &device->power.states[state];
        char pathname[5] = { '_', 'P', 'R', '0' + state, '\0' };
        struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
        acpi_status status;

        INIT_LIST_HEAD(&ps->resources);

        /* Evaluate "_PRx" to get referenced power resources */
        status = acpi_evaluate_object(device->handle, pathname, NULL, &buffer);
        if (ACPI_SUCCESS(status)) {
                union acpi_object *package = buffer.pointer;

                if (buffer.length && package
                    && package->type == ACPI_TYPE_PACKAGE
                    && package->package.count)
                        acpi_extract_power_resources(package, 0, &ps->resources);

                ACPI_FREE(buffer.pointer);
        }

        /* Evaluate "_PSx" to see if we can do explicit sets */
        pathname[2] = 'S';
        if (acpi_has_method(device->handle, pathname))
                ps->flags.explicit_set = 1;

        /* State is valid if there are means to put the device into it. */
        if (!list_empty(&ps->resources) || ps->flags.explicit_set)
                ps->flags.valid = 1;

        ps->power = -1;                /* Unknown - driver assigned */
        ps->latency = -1;        /* Unknown - driver assigned */
}

static void acpi_bus_get_power_flags(struct acpi_device *device)
{
        unsigned long long dsc = ACPI_STATE_D0;
        u32 i;

        /* Presence of _PS0|_PR0 indicates 'power manageable' */
        if (!acpi_has_method(device->handle, "_PS0") &&
            !acpi_has_method(device->handle, "_PR0"))
                return;

        device->flags.power_manageable = 1;

        /*
         * Power Management Flags
         */
        if (acpi_has_method(device->handle, "_PSC"))
                device->power.flags.explicit_get = 1;

        if (acpi_has_method(device->handle, "_IRC"))
                device->power.flags.inrush_current = 1;

        if (acpi_has_method(device->handle, "_DSW"))
                device->power.flags.dsw_present = 1;

        acpi_evaluate_integer(device->handle, "_DSC", NULL, &dsc);
        device->power.state_for_enumeration = dsc;

        /*
         * Enumerate supported power management states
         */
        for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++)
                acpi_bus_init_power_state(device, i);

        INIT_LIST_HEAD(&device->power.states[ACPI_STATE_D3_COLD].resources);

        /* Set the defaults for D0 and D3hot (always supported). */
        device->power.states[ACPI_STATE_D0].flags.valid = 1;
        device->power.states[ACPI_STATE_D0].power = 100;
        device->power.states[ACPI_STATE_D3_HOT].flags.valid = 1;

        /*
         * Use power resources only if the D0 list of them is populated, because
         * some platforms may provide _PR3 only to indicate D3cold support and
         * in those cases the power resources list returned by it may be bogus.
         */
        if (!list_empty(&device->power.states[ACPI_STATE_D0].resources)) {
                device->power.flags.power_resources = 1;
                /*
                 * D3cold is supported if the D3hot list of power resources is
                 * not empty.
                 */
                if (!list_empty(&device->power.states[ACPI_STATE_D3_HOT].resources))
                        device->power.states[ACPI_STATE_D3_COLD].flags.valid = 1;
        }

        if (acpi_bus_init_power(device))
                device->flags.power_manageable = 0;
}

static void acpi_bus_get_flags(struct acpi_device *device)
{
        /* Presence of _STA indicates 'dynamic_status' */
        if (acpi_has_method(device->handle, "_STA"))
                device->flags.dynamic_status = 1;

        /* Presence of _RMV indicates 'removable' */
        if (acpi_has_method(device->handle, "_RMV"))
                device->flags.removable = 1;

        /* Presence of _EJD|_EJ0 indicates 'ejectable' */
        if (acpi_has_method(device->handle, "_EJD") ||
            acpi_has_method(device->handle, "_EJ0"))
                device->flags.ejectable = 1;
}

static void acpi_device_get_busid(struct acpi_device *device)
{
        char bus_id[5] = { '?', 0 };
        struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
        int i = 0;

        /*
         * Bus ID
         * ------
         * The device's Bus ID is simply the object name.
         * TBD: Shouldn't this value be unique (within the ACPI namespace)?
         */
        if (!acpi_dev_parent(device)) {
                strscpy(device->pnp.bus_id, "ACPI");
                return;
        }

        switch (device->device_type) {
        case ACPI_BUS_TYPE_POWER_BUTTON:
                strscpy(device->pnp.bus_id, "PWRF");
                break;
        case ACPI_BUS_TYPE_SLEEP_BUTTON:
                strscpy(device->pnp.bus_id, "SLPF");
                break;
        case ACPI_BUS_TYPE_ECDT_EC:
                strscpy(device->pnp.bus_id, "ECDT");
                break;
        default:
                acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
                /* Clean up trailing underscores (if any) */
                for (i = 3; i > 1; i--) {
                        if (bus_id[i] == '_')
                                bus_id[i] = '\0';
                        else
                                break;
                }
                strscpy(device->pnp.bus_id, bus_id);
                break;
        }
}

/*
 * acpi_ata_match - see if an acpi object is an ATA device
 *
 * If an acpi object has one of the ACPI ATA methods defined,
 * then we can safely call it an ATA device.
 */
bool acpi_ata_match(acpi_handle handle)
{
        return acpi_has_method(handle, "_GTF") ||
               acpi_has_method(handle, "_GTM") ||
               acpi_has_method(handle, "_STM") ||
               acpi_has_method(handle, "_SDD");
}

/*
 * acpi_bay_match - see if an acpi object is an ejectable driver bay
 *
 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
 * then we can safely call it an ejectable drive bay
 */
bool acpi_bay_match(acpi_handle handle)
{
        acpi_handle phandle;

        if (!acpi_has_method(handle, "_EJ0"))
                return false;
        if (acpi_ata_match(handle))
                return true;
        if (ACPI_FAILURE(acpi_get_parent(handle, &phandle)))
                return false;

        return acpi_ata_match(phandle);
}

bool acpi_device_is_battery(struct acpi_device *adev)
{
        struct acpi_hardware_id *hwid;

        list_for_each_entry(hwid, &adev->pnp.ids, list)
                if (!strcmp("PNP0C0A", hwid->id))
                        return true;

        return false;
}

static bool is_ejectable_bay(struct acpi_device *adev)
{
        acpi_handle handle = adev->handle;

        if (acpi_has_method(handle, "_EJ0") && acpi_device_is_battery(adev))
                return true;

        return acpi_bay_match(handle);
}

/*
 * acpi_dock_match - see if an acpi object has a _DCK method
 */
bool acpi_dock_match(acpi_handle handle)
{
        return acpi_has_method(handle, "_DCK");
}

static acpi_status
acpi_backlight_cap_match(acpi_handle handle, u32 level, void *context,
                          void **return_value)
{
        long *cap = context;

        if (acpi_has_method(handle, "_BCM") &&
            acpi_has_method(handle, "_BCL")) {
                acpi_handle_debug(handle, "Found generic backlight support\n");
                *cap |= ACPI_VIDEO_BACKLIGHT;
                /* We have backlight support, no need to scan further */
                return AE_CTRL_TERMINATE;
        }
        return 0;
}

/* Returns true if the ACPI object is a video device which can be
 * handled by video.ko.
 * The device will get a Linux specific CID added in scan.c to
 * identify the device as an ACPI graphics device
 * Be aware that the graphics device may not be physically present
 */
long acpi_is_video_device(acpi_handle handle)
{
        long video_caps = 0;

        /* Is this device able to support video switching ? */
        if (acpi_has_method(handle, "_DOD") || acpi_has_method(handle, "_DOS"))
                video_caps |= ACPI_VIDEO_OUTPUT_SWITCHING;

        /* Is this device able to retrieve a video ROM ? */
        if (acpi_has_method(handle, "_ROM"))
                video_caps |= ACPI_VIDEO_ROM_AVAILABLE;

        /* Is this device able to configure which video head to be POSTed ? */
        if (acpi_has_method(handle, "_VPO") &&
            acpi_has_method(handle, "_GPD") &&
            acpi_has_method(handle, "_SPD"))
                video_caps |= ACPI_VIDEO_DEVICE_POSTING;

        /* Only check for backlight functionality if one of the above hit. */
        if (video_caps)
                acpi_walk_namespace(ACPI_TYPE_DEVICE, handle,
                                    ACPI_UINT32_MAX, acpi_backlight_cap_match, NULL,
                                    &video_caps, NULL);

        return video_caps;
}
EXPORT_SYMBOL(acpi_is_video_device);

const char *acpi_device_hid(struct acpi_device *device)
{
        struct acpi_hardware_id *hid;

        hid = list_first_entry_or_null(&device->pnp.ids, struct acpi_hardware_id, list);
        if (!hid)
                return dummy_hid;

        return hid->id;
}
EXPORT_SYMBOL(acpi_device_hid);

static void acpi_add_id(struct acpi_device_pnp *pnp, const char *dev_id)
{
        struct acpi_hardware_id *id;

        id = kmalloc_obj(*id);
        if (!id)
                return;

        id->id = kstrdup_const(dev_id, GFP_KERNEL);
        if (!id->id) {
                kfree(id);
                return;
        }

        list_add_tail(&id->list, &pnp->ids);
        pnp->type.hardware_id = 1;
}

/*
 * Old IBM workstations have a DSDT bug wherein the SMBus object
 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
 * prefix.  Work around this.
 */
static bool acpi_ibm_smbus_match(acpi_handle handle)
{
        char node_name[ACPI_PATH_SEGMENT_LENGTH];
        struct acpi_buffer path = { sizeof(node_name), node_name };

        if (!dmi_name_in_vendors("IBM"))
                return false;

        /* Look for SMBS object */
        if (ACPI_FAILURE(acpi_get_name(handle, ACPI_SINGLE_NAME, &path)) ||
            strcmp("SMBS", path.pointer))
                return false;

        /* Does it have the necessary (but misnamed) methods? */
        if (acpi_has_method(handle, "SBI") &&
            acpi_has_method(handle, "SBR") &&
            acpi_has_method(handle, "SBW"))
                return true;

        return false;
}

static bool acpi_object_is_system_bus(acpi_handle handle)
{
        acpi_handle tmp;

        if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_SB", &tmp)) &&
            tmp == handle)
                return true;
        if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_TZ", &tmp)) &&
            tmp == handle)
                return true;

        return false;
}

static void acpi_set_pnp_ids(acpi_handle handle, struct acpi_device_pnp *pnp,
                             int device_type)
{
        struct acpi_device_info *info = NULL;
        struct acpi_pnp_device_id_list *cid_list;
        int i;

        switch (device_type) {
        case ACPI_BUS_TYPE_DEVICE:
                if (handle == ACPI_ROOT_OBJECT) {
                        acpi_add_id(pnp, ACPI_SYSTEM_HID);
                        break;
                }

                acpi_get_object_info(handle, &info);
                if (!info) {
                        pr_err("%s: Error reading device info\n", __func__);
                        return;
                }

                if (info->valid & ACPI_VALID_HID) {
                        acpi_add_id(pnp, info->hardware_id.string);
                        pnp->type.platform_id = 1;
                }
                if (info->valid & ACPI_VALID_CID) {
                        cid_list = &info->compatible_id_list;
                        for (i = 0; i < cid_list->count; i++)
                                acpi_add_id(pnp, cid_list->ids[i].string);
                }
                if (info->valid & ACPI_VALID_ADR) {
                        pnp->bus_address = info->address;
                        pnp->type.bus_address = 1;
                }
                if (info->valid & ACPI_VALID_UID)
                        pnp->unique_id = kstrdup(info->unique_id.string,
                                                        GFP_KERNEL);
                if (info->valid & ACPI_VALID_CLS)
                        acpi_add_id(pnp, info->class_code.string);

                kfree(info);

                /*
                 * Some devices don't reliably have _HIDs & _CIDs, so add
                 * synthetic HIDs to make sure drivers can find them.
                 */
                if (acpi_is_video_device(handle)) {
                        acpi_add_id(pnp, ACPI_VIDEO_HID);
                        pnp->type.backlight = 1;
                        break;
                }
                if (acpi_bay_match(handle))
                        acpi_add_id(pnp, ACPI_BAY_HID);
                else if (acpi_dock_match(handle))
                        acpi_add_id(pnp, ACPI_DOCK_HID);
                else if (acpi_ibm_smbus_match(handle))
                        acpi_add_id(pnp, ACPI_SMBUS_IBM_HID);
                else if (list_empty(&pnp->ids) &&
                         acpi_object_is_system_bus(handle)) {
                        /* \_SB, \_TZ, LNXSYBUS */
                        acpi_add_id(pnp, ACPI_BUS_HID);
                        strscpy(pnp->device_name, ACPI_BUS_DEVICE_NAME);
                        strscpy(pnp->device_class, ACPI_BUS_CLASS);
                }

                break;
        case ACPI_BUS_TYPE_POWER:
                acpi_add_id(pnp, ACPI_POWER_HID);
                break;
        case ACPI_BUS_TYPE_PROCESSOR:
                acpi_add_id(pnp, ACPI_PROCESSOR_OBJECT_HID);
                break;
        case ACPI_BUS_TYPE_THERMAL:
                acpi_add_id(pnp, ACPI_THERMAL_HID);
                pnp->type.platform_id = 1;
                break;
        case ACPI_BUS_TYPE_POWER_BUTTON:
                acpi_add_id(pnp, ACPI_BUTTON_HID_POWERF);
                break;
        case ACPI_BUS_TYPE_SLEEP_BUTTON:
                acpi_add_id(pnp, ACPI_BUTTON_HID_SLEEPF);
                break;
        case ACPI_BUS_TYPE_ECDT_EC:
                acpi_add_id(pnp, ACPI_ECDT_HID);
                break;
        }
}

void acpi_free_pnp_ids(struct acpi_device_pnp *pnp)
{
        struct acpi_hardware_id *id, *tmp;

        list_for_each_entry_safe(id, tmp, &pnp->ids, list) {
                kfree_const(id->id);
                kfree(id);
        }
        kfree(pnp->unique_id);
}

/**
 * acpi_dma_supported - Check DMA support for the specified device.
 * @adev: The pointer to acpi device
 *
 * Return false if DMA is not supported. Otherwise, return true
 */
bool acpi_dma_supported(const struct acpi_device *adev)
{
        if (!adev)
                return false;

        if (adev->flags.cca_seen)
                return true;

        /*
        * Per ACPI 6.0 sec 6.2.17, assume devices can do cache-coherent
        * DMA on "Intel platforms".  Presumably that includes all x86 and
        * ia64, and other arches will set CONFIG_ACPI_CCA_REQUIRED=y.
        */
        if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
                return true;

        return false;
}

/**
 * acpi_get_dma_attr - Check the supported DMA attr for the specified device.
 * @adev: The pointer to acpi device
 *
 * Return enum dev_dma_attr.
 */
enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
{
        if (!acpi_dma_supported(adev))
                return DEV_DMA_NOT_SUPPORTED;

        if (adev->flags.coherent_dma)
                return DEV_DMA_COHERENT;
        else
                return DEV_DMA_NON_COHERENT;
}

/**
 * acpi_dma_get_range() - Get device DMA parameters.
 *
 * @dev: device to configure
 * @map: pointer to DMA ranges result
 *
 * Evaluate DMA regions and return pointer to DMA regions on
 * parsing success; it does not update the passed in values on failure.
 *
 * Return 0 on success, < 0 on failure.
 */
int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map)
{
        struct acpi_device *adev;
        LIST_HEAD(list);
        struct resource_entry *rentry;
        int ret;
        struct device *dma_dev = dev;
        struct bus_dma_region *r;

        /*
         * Walk the device tree chasing an ACPI companion with a _DMA
         * object while we go. Stop if we find a device with an ACPI
         * companion containing a _DMA method.
         */
        do {
                adev = ACPI_COMPANION(dma_dev);
                if (adev && acpi_has_method(adev->handle, METHOD_NAME__DMA))
                        break;

                dma_dev = dma_dev->parent;
        } while (dma_dev);

        if (!dma_dev)
                return -ENODEV;

        if (!acpi_has_method(adev->handle, METHOD_NAME__CRS)) {
                acpi_handle_warn(adev->handle, "_DMA is valid only if _CRS is present\n");
                return -EINVAL;
        }

        ret = acpi_dev_get_dma_resources(adev, &list);
        if (ret > 0) {
                r = kzalloc_objs(*r, ret + 1);
                if (!r) {
                        ret = -ENOMEM;
                        goto out;
                }

                *map = r;

                list_for_each_entry(rentry, &list, node) {
                        if (rentry->res->start >= rentry->res->end) {
                                kfree(*map);
                                *map = NULL;
                                ret = -EINVAL;
                                dev_dbg(dma_dev, "Invalid DMA regions configuration\n");
                                goto out;
                        }

                        r->cpu_start = rentry->res->start;
                        r->dma_start = rentry->res->start - rentry->offset;
                        r->size = resource_size(rentry->res);
                        r++;
                }
        }
 out:
        acpi_dev_free_resource_list(&list);

        return ret >= 0 ? 0 : ret;
}

#ifdef CONFIG_IOMMU_API
int acpi_iommu_fwspec_init(struct device *dev, u32 id,
                           struct fwnode_handle *fwnode)
{
        int ret;

        ret = iommu_fwspec_init(dev, fwnode);
        if (ret)
                return ret;

        return iommu_fwspec_add_ids(dev, &id, 1);
}

static int acpi_iommu_configure_id(struct device *dev, const u32 *id_in)
{
        int err;

        /* Serialise to make dev->iommu stable under our potential fwspec */
        mutex_lock(&iommu_probe_device_lock);
        /* If we already translated the fwspec there is nothing left to do */
        if (dev_iommu_fwspec_get(dev)) {
                mutex_unlock(&iommu_probe_device_lock);
                return 0;
        }

        err = iort_iommu_configure_id(dev, id_in);
        if (err && err != -EPROBE_DEFER)
                err = rimt_iommu_configure_id(dev, id_in);
        if (err && err != -EPROBE_DEFER)
                err = viot_iommu_configure(dev);

        mutex_unlock(&iommu_probe_device_lock);

        return err;
}

#else /* !CONFIG_IOMMU_API */

int acpi_iommu_fwspec_init(struct device *dev, u32 id,
                           struct fwnode_handle *fwnode)
{
        return -ENODEV;
}

static int acpi_iommu_configure_id(struct device *dev, const u32 *id_in)
{
        return -ENODEV;
}

#endif /* !CONFIG_IOMMU_API */

/**
 * acpi_dma_configure_id - Set-up DMA configuration for the device.
 * @dev: The pointer to the device
 * @attr: device dma attributes
 * @input_id: input device id const value pointer
 */
int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
                          const u32 *input_id)
{
        int ret;

        if (attr == DEV_DMA_NOT_SUPPORTED) {
                set_dma_ops(dev, &dma_dummy_ops);
                return 0;
        }

        acpi_arch_dma_setup(dev);

        /* Ignore all other errors apart from EPROBE_DEFER */
        ret = acpi_iommu_configure_id(dev, input_id);
        if (ret == -EPROBE_DEFER)
                return -EPROBE_DEFER;
        if (ret)
                dev_dbg(dev, "Adding to IOMMU failed: %d\n", ret);

        arch_setup_dma_ops(dev, attr == DEV_DMA_COHERENT);

        return 0;
}
EXPORT_SYMBOL_GPL(acpi_dma_configure_id);

static void acpi_init_coherency(struct acpi_device *adev)
{
        unsigned long long cca = 0;
        acpi_status status;
        struct acpi_device *parent = acpi_dev_parent(adev);

        if (parent && parent->flags.cca_seen) {
                /*
                 * From ACPI spec, OSPM will ignore _CCA if an ancestor
                 * already saw one.
                 */
                adev->flags.cca_seen = 1;
                cca = parent->flags.coherent_dma;
        } else {
                status = acpi_evaluate_integer(adev->handle, "_CCA",
                                               NULL, &cca);
                if (ACPI_SUCCESS(status))
                        adev->flags.cca_seen = 1;
                else if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
                        /*
                         * If architecture does not specify that _CCA is
                         * required for DMA-able devices (e.g. x86),
                         * we default to _CCA=1.
                         */
                        cca = 1;
                else
                        acpi_handle_debug(adev->handle,
                                          "ACPI device is missing _CCA.\n");
        }

        adev->flags.coherent_dma = cca;
}

static int acpi_check_serial_bus_slave(struct acpi_resource *ares, void *data)
{
        bool *is_serial_bus_slave_p = data;

        if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
                return 1;

        *is_serial_bus_slave_p = true;

         /* no need to do more checking */
        return -1;
}

static bool acpi_is_indirect_io_slave(struct acpi_device *device)
{
        struct acpi_device *parent = acpi_dev_parent(device);
        static const struct acpi_device_id indirect_io_hosts[] = {
                {"HISI0191", 0},
                {}
        };

        return parent && !acpi_match_device_ids(parent, indirect_io_hosts);
}

static bool acpi_device_enumeration_by_parent(struct acpi_device *device)
{
        struct list_head resource_list;
        bool is_serial_bus_slave = false;
        static const struct acpi_device_id ignore_serial_bus_ids[] = {
        /*
         * These devices have multiple SerialBus resources and a client
         * device must be instantiated for each of them, each with
         * its own device id.
         * Normally we only instantiate one client device for the first
         * resource, using the ACPI HID as id. These special cases are handled
         * by the drivers/platform/x86/serial-multi-instantiate.c driver, which
         * knows which client device id to use for each resource.
         */
                {"BSG1160", },
                {"BSG2150", },
                {"CSC3551", },
                {"CSC3554", },
                {"CSC3556", },
                {"CSC3557", },
                {"INT33FE", },
                {"INT3515", },
                {"TXNW2781", },
                /* Non-conforming _HID for Cirrus Logic already released */
                {"CLSA0100", },
                {"CLSA0101", },
        /*
         * Some ACPI devs contain SerialBus resources even though they are not
         * attached to a serial bus at all.
         */
                {ACPI_VIDEO_HID, },
                {"MSHW0028", },
        /*
         * HIDs of device with an UartSerialBusV2 resource for which userspace
         * expects a regular tty cdev to be created (instead of the in kernel
         * serdev) and which have a kernel driver which expects a platform_dev
         * such as the rfkill-gpio driver.
         */
                {"BCM4752", },
                {"LNV4752", },
                {}
        };

        if (acpi_is_indirect_io_slave(device))
                return true;

        /* Macs use device properties in lieu of _CRS resources */
        if (x86_apple_machine &&
            (fwnode_property_present(&device->fwnode, "spiSclkPeriod") ||
             fwnode_property_present(&device->fwnode, "i2cAddress") ||
             fwnode_property_present(&device->fwnode, "baud")))
                return true;

        if (!acpi_match_device_ids(device, ignore_serial_bus_ids))
                return false;

        INIT_LIST_HEAD(&resource_list);
        acpi_dev_get_resources(device, &resource_list,
                               acpi_check_serial_bus_slave,
                               &is_serial_bus_slave);
        acpi_dev_free_resource_list(&resource_list);

        return is_serial_bus_slave;
}

void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
                             int type, void (*release)(struct device *))
{
        struct acpi_device *parent = acpi_find_parent_acpi_dev(handle);

        INIT_LIST_HEAD(&device->pnp.ids);
        device->device_type = type;
        device->handle = handle;
        device->dev.parent = parent ? &parent->dev : NULL;
        device->dev.release = release;
        device->dev.bus = &acpi_bus_type;
        device->dev.groups = acpi_groups;
        fwnode_init(&device->fwnode, &acpi_device_fwnode_ops);
        acpi_set_device_status(device, ACPI_STA_DEFAULT);
        acpi_device_get_busid(device);
        acpi_set_pnp_ids(handle, &device->pnp, type);
        acpi_init_properties(device);
        acpi_bus_get_flags(device);
        device->flags.match_driver = false;
        device->flags.initialized = true;
        device->flags.enumeration_by_parent =
                acpi_device_enumeration_by_parent(device);
        acpi_device_clear_enumerated(device);
        device_initialize(&device->dev);
        dev_set_uevent_suppress(&device->dev, true);
        acpi_init_coherency(device);
}

static void acpi_scan_dep_init(struct acpi_device *adev)
{
        struct acpi_dep_data *dep;

        list_for_each_entry(dep, &acpi_dep_list, node) {
                if (dep->consumer == adev->handle) {
                        if (dep->honor_dep)
                                adev->flags.honor_deps = 1;

                        if (!dep->met)
                                adev->dep_unmet++;
                }
        }
}

void acpi_device_add_finalize(struct acpi_device *device)
{
        dev_set_uevent_suppress(&device->dev, false);
        kobject_uevent(&device->dev.kobj, KOBJ_ADD);
}

static void acpi_scan_init_status(struct acpi_device *adev)
{
        if (acpi_bus_get_status(adev))
                acpi_set_device_status(adev, 0);
}

static int acpi_add_single_object(struct acpi_device **child,
                                  acpi_handle handle, int type, bool dep_init)
{
        struct acpi_device *device;
        bool release_dep_lock = false;
        int result;

        device = kzalloc_obj(struct acpi_device);
        if (!device)
                return -ENOMEM;

        acpi_init_device_object(device, handle, type, acpi_device_release);
        /*
         * Getting the status is delayed till here so that we can call
         * acpi_bus_get_status() and use its quirk handling.  Note that
         * this must be done before the get power-/wakeup_dev-flags calls.
         */
        if (type == ACPI_BUS_TYPE_DEVICE || type == ACPI_BUS_TYPE_PROCESSOR) {
                if (dep_init) {
                        mutex_lock(&acpi_dep_list_lock);
                        /*
                         * Hold the lock until the acpi_tie_acpi_dev() call
                         * below to prevent concurrent acpi_scan_clear_dep()
                         * from deleting a dependency list entry without
                         * updating dep_unmet for the device.
                         */
                        release_dep_lock = true;
                        acpi_scan_dep_init(device);
                }
                acpi_scan_init_status(device);
        }

        acpi_bus_get_power_flags(device);
        acpi_bus_get_wakeup_device_flags(device);

        result = acpi_tie_acpi_dev(device);

        if (release_dep_lock)
                mutex_unlock(&acpi_dep_list_lock);

        if (!result)
                result = acpi_device_add(device);

        if (result) {
                acpi_dev_put(device);
                return result;
        }

        acpi_power_add_remove_device(device, true);
        acpi_device_add_finalize(device);

        acpi_handle_debug(handle, "Added as %s, parent %s\n",
                          dev_name(&device->dev), device->dev.parent ?
                                dev_name(device->dev.parent) : "(null)");

        *child = device;
        return 0;
}

static acpi_status acpi_get_resource_memory(struct acpi_resource *ares,
                                            void *context)
{
        struct resource *res = context;

        if (acpi_dev_resource_memory(ares, res))
                return AE_CTRL_TERMINATE;

        return AE_OK;
}

static bool acpi_device_should_be_hidden(acpi_handle handle)
{
        acpi_status status;
        struct resource res;

        /* Check if it should ignore the UART device */
        if (!(spcr_uart_addr && acpi_has_method(handle, METHOD_NAME__CRS)))
                return false;

        /*
         * The UART device described in SPCR table is assumed to have only one
         * memory resource present. So we only look for the first one here.
         */
        status = acpi_walk_resources(handle, METHOD_NAME__CRS,
                                     acpi_get_resource_memory, &res);
        if (ACPI_FAILURE(status) || res.start != spcr_uart_addr)
                return false;

        acpi_handle_info(handle, "The UART device @%pa in SPCR table will be hidden\n",
                         &res.start);

        return true;
}

bool acpi_device_is_present(const struct acpi_device *adev)
{
        return adev->status.present || adev->status.functional;
}

bool acpi_device_is_enabled(const struct acpi_device *adev)
{
        return adev->status.enabled;
}

static bool acpi_scan_handler_matching(struct acpi_scan_handler *handler,
                                       const char *idstr,
                                       const struct acpi_device_id **matchid)
{
        const struct acpi_device_id *devid;

        if (handler->match)
                return handler->match(idstr, matchid);

        for (devid = handler->ids; devid->id[0]; devid++)
                if (!strcmp((char *)devid->id, idstr)) {
                        if (matchid)
                                *matchid = devid;

                        return true;
                }

        return false;
}

static struct acpi_scan_handler *acpi_scan_match_handler(const char *idstr,
                                        const struct acpi_device_id **matchid)
{
        struct acpi_scan_handler *handler;

        list_for_each_entry(handler, &acpi_scan_handlers_list, list_node)
                if (acpi_scan_handler_matching(handler, idstr, matchid))
                        return handler;

        return NULL;
}

void acpi_scan_hotplug_enabled(struct acpi_hotplug_profile *hotplug, bool val)
{
        if (!!hotplug->enabled == !!val)
                return;

        mutex_lock(&acpi_scan_lock);

        hotplug->enabled = val;

        mutex_unlock(&acpi_scan_lock);
}

int acpi_scan_add_dep(acpi_handle handle, struct acpi_handle_list *dep_devices)
{
        u32 count;
        int i;

        for (count = 0, i = 0; i < dep_devices->count; i++) {
                struct acpi_device_info *info;
                struct acpi_dep_data *dep;
                bool skip, honor_dep;
                acpi_status status;

                status = acpi_get_object_info(dep_devices->handles[i], &info);
                if (ACPI_FAILURE(status)) {
                        acpi_handle_debug(handle, "Error reading _DEP device info\n");
                        continue;
                }

                skip = acpi_info_matches_ids(info, acpi_ignore_dep_ids);
                honor_dep = acpi_info_matches_ids(info, acpi_honor_dep_ids);
                kfree(info);

                if (skip)
                        continue;

                dep = kzalloc_obj(*dep);
                if (!dep)
                        continue;

                count++;

                dep->supplier = dep_devices->handles[i];
                dep->consumer = handle;
                dep->honor_dep = honor_dep;

                mutex_lock(&acpi_dep_list_lock);
                list_add_tail(&dep->node, &acpi_dep_list);
                mutex_unlock(&acpi_dep_list_lock);
        }

        acpi_handle_list_free(dep_devices);
        return count;
}

static void acpi_scan_init_hotplug(struct acpi_device *adev)
{
        struct acpi_hardware_id *hwid;

        if (acpi_dock_match(adev->handle) || is_ejectable_bay(adev)) {
                acpi_dock_add(adev);
                return;
        }
        list_for_each_entry(hwid, &adev->pnp.ids, list) {
                struct acpi_scan_handler *handler;

                handler = acpi_scan_match_handler(hwid->id, NULL);
                if (handler) {
                        adev->flags.hotplug_notify = true;
                        break;
                }
        }
}

u32 __weak arch_acpi_add_auto_dep(acpi_handle handle) { return 0; }

static u32 acpi_scan_check_dep(acpi_handle handle)
{
        struct acpi_handle_list dep_devices;
        u32 count = 0;

        /*
         * Some architectures like RISC-V need to add dependencies for
         * all devices which use GSI to the interrupt controller so that
         * interrupt controller is probed before any of those devices.
         * Instead of mandating _DEP on all the devices, detect the
         * dependency and add automatically.
         */
        count += arch_acpi_add_auto_dep(handle);

        /*
         * Check for _HID here to avoid deferring the enumeration of:
         * 1. PCI devices.
         * 2. ACPI nodes describing USB ports.
         * Still, checking for _HID catches more then just these cases ...
         */
        if (!acpi_has_method(handle, "_DEP") || !acpi_has_method(handle, "_HID"))
                return count;

        if (!acpi_evaluate_reference(handle, "_DEP", NULL, &dep_devices)) {
                acpi_handle_debug(handle, "Failed to evaluate _DEP.\n");
                return count;
        }

        count += acpi_scan_add_dep(handle, &dep_devices);
        return count;
}

static acpi_status acpi_scan_check_crs_csi2_cb(acpi_handle handle, u32 a, void *b, void **c)
{
        acpi_mipi_check_crs_csi2(handle);
        return AE_OK;
}

static acpi_status acpi_bus_check_add(acpi_handle handle, bool first_pass,
                                      struct acpi_device **adev_p)
{
        struct acpi_device *device = acpi_fetch_acpi_dev(handle);
        acpi_object_type acpi_type;
        int type;

        if (device)
                goto out;

        if (ACPI_FAILURE(acpi_get_type(handle, &acpi_type)))
                return AE_OK;

        switch (acpi_type) {
        case ACPI_TYPE_DEVICE:
                if (acpi_device_should_be_hidden(handle))
                        return AE_OK;

                if (first_pass) {
                        acpi_mipi_check_crs_csi2(handle);

                        /* Bail out if there are dependencies. */
                        if (acpi_scan_check_dep(handle) > 0) {
                                /*
                                 * The entire CSI-2 connection graph needs to be
                                 * extracted before any drivers or scan handlers
                                 * are bound to struct device objects, so scan
                                 * _CRS CSI-2 resource descriptors for all
                                 * devices below the current handle.
                                 */
                                acpi_walk_namespace(ACPI_TYPE_DEVICE, handle,
                                                    ACPI_UINT32_MAX,
                                                    acpi_scan_check_crs_csi2_cb,
                                                    NULL, NULL, NULL);
                                return AE_CTRL_DEPTH;
                        }
                }

                fallthrough;
        case ACPI_TYPE_ANY:        /* for ACPI_ROOT_OBJECT */
                type = ACPI_BUS_TYPE_DEVICE;
                break;

        case ACPI_TYPE_PROCESSOR:
                type = ACPI_BUS_TYPE_PROCESSOR;
                break;

        case ACPI_TYPE_THERMAL:
                type = ACPI_BUS_TYPE_THERMAL;
                break;

        case ACPI_TYPE_POWER:
                acpi_add_power_resource(handle);
                fallthrough;
        default:
                return AE_OK;
        }

        /*
         * If first_pass is true at this point, the device has no dependencies,
         * or the creation of the device object would have been postponed above.
         */
        acpi_add_single_object(&device, handle, type, !first_pass);
        if (!device)
                return AE_CTRL_DEPTH;

        acpi_scan_init_hotplug(device);

out:
        if (!*adev_p)
                *adev_p = device;

        return AE_OK;
}

static acpi_status acpi_bus_check_add_1(acpi_handle handle, u32 lvl_not_used,
                                        void *not_used, void **ret_p)
{
        return acpi_bus_check_add(handle, true, (struct acpi_device **)ret_p);
}

static acpi_status acpi_bus_check_add_2(acpi_handle handle, u32 lvl_not_used,
                                        void *not_used, void **ret_p)
{
        return acpi_bus_check_add(handle, false, (struct acpi_device **)ret_p);
}

static void acpi_video_bus_device_release(struct device *dev)
{
        struct auxiliary_device *aux_dev = to_auxiliary_dev(dev);

        kfree(aux_dev);
}

static void acpi_create_video_bus_device(struct acpi_device *adev,
                                         struct acpi_device *parent)
{
        struct auxiliary_device *aux_dev;
        static unsigned int aux_dev_id;

        aux_dev = kzalloc_obj(*aux_dev);
        if (!aux_dev)
                return;

        aux_dev->id = aux_dev_id++;
        aux_dev->name = "video_bus";
        aux_dev->dev.parent = acpi_get_first_physical_node(parent);
        if (!aux_dev->dev.parent)
                goto err;

        aux_dev->dev.release = acpi_video_bus_device_release;

        if (auxiliary_device_init(aux_dev))
                goto err;

        ACPI_COMPANION_SET(&aux_dev->dev, adev);
        if (__auxiliary_device_add(aux_dev, "acpi"))
                auxiliary_device_uninit(aux_dev);

        return;

err:
        kfree(aux_dev);
}

struct acpi_scan_system_dev {
        struct list_head node;
        struct acpi_device *adev;
};

static const char * const acpi_system_dev_ids[] = {
        "PNP0C01", /* Memory controller */
        "PNP0C02", /* Motherboard resource */
        NULL
};

static void acpi_default_enumeration(struct acpi_device *device)
{
        /*
         * Do not enumerate devices with enumeration_by_parent flag set as
         * they will be enumerated by their respective parents.
         */
        if (device->flags.enumeration_by_parent) {
                blocking_notifier_call_chain(&acpi_reconfig_chain,
                                             ACPI_RECONFIG_DEVICE_ADD, device);
                return;
        }
        if (match_string(acpi_system_dev_ids, -1, acpi_device_hid(device)) >= 0) {
                struct acpi_scan_system_dev *sd;

                /*
                 * This is a generic system device, so there is no need to
                 * create a platform device for it, but its resources need to be
                 * reserved.  However, that needs to be done after all of the
                 * other device objects have been processed and PCI has claimed
                 * BARs in case there are resource conflicts.
                 */
                sd = kmalloc_obj(*sd);
                if (sd) {
                        sd->adev = device;
                        list_add_tail(&sd->node, &acpi_scan_system_dev_list);
                }
        } else if (device->pnp.type.backlight) {
                struct acpi_device *parent;

                parent = acpi_dev_parent(device);
                if (parent)
                        acpi_create_video_bus_device(device, parent);
        } else {
                /* For a regular device object, create a platform device. */
                acpi_create_platform_device(device, NULL);
        }
        acpi_device_set_enumerated(device);
}

static const struct acpi_device_id generic_device_ids[] = {
        {ACPI_DT_NAMESPACE_HID, },
        {"", },
};

static int acpi_generic_device_attach(struct acpi_device *adev,
                                      const struct acpi_device_id *not_used)
{
        /*
         * Since ACPI_DT_NAMESPACE_HID is the only ID handled here, the test
         * below can be unconditional.
         */
        if (adev->data.of_compatible)
                acpi_default_enumeration(adev);

        return 1;
}

static struct acpi_scan_handler generic_device_handler = {
        .ids = generic_device_ids,
        .attach = acpi_generic_device_attach,
};

static int acpi_scan_attach_handler(struct acpi_device *device)
{
        struct acpi_hardware_id *hwid;
        int ret = 0;

        list_for_each_entry(hwid, &device->pnp.ids, list) {
                const struct acpi_device_id *devid;
                struct acpi_scan_handler *handler;

                handler = acpi_scan_match_handler(hwid->id, &devid);
                if (handler) {
                        if (!handler->attach) {
                                device->pnp.type.platform_id = 0;
                                continue;
                        }
                        device->handler = handler;
                        ret = handler->attach(device, devid);
                        if (ret > 0)
                                break;

                        device->handler = NULL;
                        if (ret < 0)
                                break;
                }
        }

        return ret;
}

static int acpi_bus_attach(struct acpi_device *device, void *first_pass)
{
        bool skip = !first_pass && device->flags.visited;
        acpi_handle ejd;
        int ret;

        if (skip)
                goto ok;

        if (ACPI_SUCCESS(acpi_bus_get_ejd(device->handle, &ejd)))
                register_dock_dependent_device(device, ejd);

        acpi_bus_get_status(device);
        /* Skip devices that are not ready for enumeration (e.g. not present) */
        if (!acpi_dev_ready_for_enumeration(device)) {
                device->flags.initialized = false;
                acpi_device_clear_enumerated(device);
                device->flags.power_manageable = 0;
                return 0;
        }
        if (device->handler)
                goto ok;

        acpi_ec_register_opregions(device);

        if (!device->flags.initialized) {
                device->flags.power_manageable =
                        device->power.states[ACPI_STATE_D0].flags.valid;
                if (acpi_bus_init_power(device))
                        device->flags.power_manageable = 0;

                device->flags.initialized = true;
        } else if (device->flags.visited) {
                goto ok;
        }

        ret = acpi_scan_attach_handler(device);
        if (ret < 0)
                return 0;

        device->flags.match_driver = true;
        if (ret > 0 && !device->flags.enumeration_by_parent) {
                acpi_device_set_enumerated(device);
                goto ok;
        }

        ret = device_attach(&device->dev);
        if (ret < 0)
                return 0;

        if (device->pnp.type.platform_id || device->pnp.type.backlight ||
            device->flags.enumeration_by_parent)
                acpi_default_enumeration(device);
        else
                acpi_device_set_enumerated(device);

ok:
        acpi_dev_for_each_child(device, acpi_bus_attach, first_pass);

        if (!skip && device->handler && device->handler->hotplug.notify_online)
                device->handler->hotplug.notify_online(device);

        return 0;
}

static int acpi_dev_get_next_consumer_dev_cb(struct acpi_dep_data *dep, void *data)
{
        struct acpi_device **adev_p = data;
        struct acpi_device *adev = *adev_p;

        /*
         * If we're passed a 'previous' consumer device then we need to skip
         * any consumers until we meet the previous one, and then NULL @data
         * so the next one can be returned.
         */
        if (adev) {
                if (dep->consumer == adev->handle)
                        *adev_p = NULL;

                return 0;
        }

        adev = acpi_get_acpi_dev(dep->consumer);
        if (adev) {
                *(struct acpi_device **)data = adev;
                return 1;
        }
        /* Continue parsing if the device object is not present. */
        return 0;
}

static void acpi_scan_clear_dep_fn(void *dev, async_cookie_t cookie)
{
        struct acpi_device *adev = to_acpi_device(dev);

        acpi_scan_lock_acquire();
        acpi_bus_attach(adev, (void *)true);
        acpi_scan_lock_release();

        acpi_dev_put(adev);
}

static bool acpi_scan_clear_dep_queue(struct acpi_device *adev)
{
        if (adev->dep_unmet)
                return false;

        /*
         * Async schedule the deferred acpi_scan_clear_dep_fn() since:
         * - acpi_bus_attach() needs to hold acpi_scan_lock which cannot
         *   be acquired under acpi_dep_list_lock (held here)
         * - the deferred work at boot stage is ensured to be finished
         *   before userspace init task by the async_synchronize_full()
         *   barrier
         *
         * Use _nocall variant since it'll return on failure instead of
         * run the function synchronously.
         */
        return async_schedule_dev_nocall(acpi_scan_clear_dep_fn, &adev->dev);
}

static void acpi_scan_delete_dep_data(struct acpi_dep_data *dep)
{
        list_del(&dep->node);
        kfree(dep);
}

static int acpi_scan_clear_dep(struct acpi_dep_data *dep, void *data)
{
        struct acpi_device *adev = acpi_get_acpi_dev(dep->consumer);

        if (adev) {
                adev->dep_unmet--;
                if (!acpi_scan_clear_dep_queue(adev))
                        acpi_dev_put(adev);
        }

        if (dep->free_when_met)
                acpi_scan_delete_dep_data(dep);
        else
                dep->met = true;

        return 0;
}

/**
 * acpi_walk_dep_device_list - Apply a callback to every entry in acpi_dep_list
 * @handle:        The ACPI handle of the supplier device
 * @callback:        Pointer to the callback function to apply
 * @data:        Pointer to some data to pass to the callback
 *
 * The return value of the callback determines this function's behaviour. If 0
 * is returned we continue to iterate over acpi_dep_list. If a positive value
 * is returned then the loop is broken but this function returns 0. If a
 * negative value is returned by the callback then the loop is broken and that
 * value is returned as the final error.
 */
static int acpi_walk_dep_device_list(acpi_handle handle,
                                int (*callback)(struct acpi_dep_data *, void *),
                                void *data)
{
        struct acpi_dep_data *dep, *tmp;
        int ret = 0;

        mutex_lock(&acpi_dep_list_lock);
        list_for_each_entry_safe(dep, tmp, &acpi_dep_list, node) {
                if (dep->supplier == handle) {
                        ret = callback(dep, data);
                        if (ret)
                                break;
                }
        }
        mutex_unlock(&acpi_dep_list_lock);

        return ret > 0 ? 0 : ret;
}

/**
 * acpi_dev_clear_dependencies - Inform consumers that the device is now active
 * @supplier: Pointer to the supplier &struct acpi_device
 *
 * Clear dependencies on the given device.
 */
void acpi_dev_clear_dependencies(struct acpi_device *supplier)
{
        acpi_walk_dep_device_list(supplier->handle, acpi_scan_clear_dep, NULL);
}
EXPORT_SYMBOL_GPL(acpi_dev_clear_dependencies);

/**
 * acpi_dev_ready_for_enumeration - Check if the ACPI device is ready for enumeration
 * @device: Pointer to the &struct acpi_device to check
 *
 * Check if the device is present and has no unmet dependencies.
 *
 * Return true if the device is ready for enumeratino. Otherwise, return false.
 */
bool acpi_dev_ready_for_enumeration(const struct acpi_device *device)
{
        if (device->flags.honor_deps && device->dep_unmet)
                return false;

        return acpi_device_is_present(device);
}
EXPORT_SYMBOL_GPL(acpi_dev_ready_for_enumeration);

/**
 * acpi_dev_get_next_consumer_dev - Return the next adev dependent on @supplier
 * @supplier: Pointer to the dependee device
 * @start: Pointer to the current dependent device
 *
 * Returns the next &struct acpi_device which declares itself dependent on
 * @supplier via the _DEP buffer, parsed from the acpi_dep_list.
 *
 * If the returned adev is not passed as @start to this function, the caller is
 * responsible for putting the reference to adev when it is no longer needed.
 */
struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
                                                   struct acpi_device *start)
{
        struct acpi_device *adev = start;

        acpi_walk_dep_device_list(supplier->handle,
                                  acpi_dev_get_next_consumer_dev_cb, &adev);

        acpi_dev_put(start);

        if (adev == start)
                return NULL;

        return adev;
}
EXPORT_SYMBOL_GPL(acpi_dev_get_next_consumer_dev);

static void acpi_scan_postponed_branch(acpi_handle handle)
{
        struct acpi_device *adev = NULL;

        if (ACPI_FAILURE(acpi_bus_check_add(handle, false, &adev)))
                return;

        acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
                            acpi_bus_check_add_2, NULL, NULL, (void **)&adev);

        /*
         * Populate the ACPI _CRS CSI-2 software nodes for the ACPI devices that
         * have been added above.
         */
        acpi_mipi_init_crs_csi2_swnodes();

        acpi_bus_attach(adev, NULL);
}

static void acpi_scan_postponed(void)
{
        struct acpi_dep_data *dep, *tmp;

        mutex_lock(&acpi_dep_list_lock);

        list_for_each_entry_safe(dep, tmp, &acpi_dep_list, node) {
                acpi_handle handle = dep->consumer;

                /*
                 * In case there are multiple acpi_dep_list entries with the
                 * same consumer, skip the current entry if the consumer device
                 * object corresponding to it is present already.
                 */
                if (!acpi_fetch_acpi_dev(handle)) {
                        /*
                         * Even though the lock is released here, tmp is
                         * guaranteed to be valid, because none of the list
                         * entries following dep is marked as "free when met"
                         * and so they cannot be deleted.
                         */
                        mutex_unlock(&acpi_dep_list_lock);

                        acpi_scan_postponed_branch(handle);

                        mutex_lock(&acpi_dep_list_lock);
                }

                if (dep->met)
                        acpi_scan_delete_dep_data(dep);
                else
                        dep->free_when_met = true;
        }

        mutex_unlock(&acpi_dep_list_lock);
}

static void acpi_scan_claim_resources(struct acpi_device *adev)
{
        struct resource_entry *rentry;
        LIST_HEAD(resource_list);
        unsigned int count = 0;
        const char *regionid;

        if (acpi_dev_get_resources(adev, &resource_list, NULL, NULL) <= 0)
                return;

        regionid = kstrdup(dev_name(&adev->dev), GFP_KERNEL);
        if (!regionid)
                goto exit;

        list_for_each_entry(rentry, &resource_list, node) {
                struct resource *res = rentry->res;
                struct resource *r;

                /* Skip disabled and invalid resources. */
                if ((res->flags & IORESOURCE_DISABLED) || res->end < res->start)
                        continue;

                if (resource_type(res) == IORESOURCE_IO) {
                        /*
                         * Follow the PNP system driver and on x86 skip I/O
                         * resources that start below 0x100 (the "standard PC
                         * hardware" boundary).
                         */
                        if (IS_ENABLED(CONFIG_X86) && res->start < 0x100) {
                                dev_info(&adev->dev, "Skipped %pR\n", res);
                                continue;
                        }
                        r = request_region(res->start, resource_size(res), regionid);
                } else if (resource_type(res) == IORESOURCE_MEM) {
                        r = request_mem_region(res->start, resource_size(res), regionid);
                } else {
                        continue;
                }

                if (r) {
                        r->flags &= ~IORESOURCE_BUSY;
                        dev_info(&adev->dev, "Reserved %pR\n", r);
                        count++;
                } else {
                        /*
                         * Failures at this point are usually harmless. PCI
                         * quirks, for example, reserve resources they know
                         * about too, so there may well be double reservations.
                         */
                        dev_info(&adev->dev, "Could not reserve %pR\n", res);
                }
        }

        if (!count)
                kfree(regionid);

exit:
        acpi_dev_free_resource_list(&resource_list);
}

static int __init acpi_reserve_motherboard_resources(void)
{
        struct acpi_scan_system_dev *sd, *tmp;

        guard(mutex)(&acpi_scan_lock);

        list_for_each_entry_safe(sd, tmp, &acpi_scan_system_dev_list, node) {
                acpi_scan_claim_resources(sd->adev);
                list_del(&sd->node);
                kfree(sd);
        }

        return 0;
}

/*
 * Reserve motherboard resources after PCI claims BARs, but before PCI assigns
 * resources for uninitialized PCI devices.
 */
fs_initcall(acpi_reserve_motherboard_resources);

/**
 * acpi_bus_scan - Add ACPI device node objects in a given namespace scope.
 * @handle: Root of the namespace scope to scan.
 *
 * Scan a given ACPI tree (probably recently hot-plugged) and create and add
 * found devices.
 *
 * If no devices were found, -ENODEV is returned, but it does not mean that
 * there has been a real error.  There just have been no suitable ACPI objects
 * in the table trunk from which the kernel could create a device and add an
 * appropriate driver.
 *
 * Must be called under acpi_scan_lock.
 */
int acpi_bus_scan(acpi_handle handle)
{
        struct acpi_device *device = NULL;

        /* Pass 1: Avoid enumerating devices with missing dependencies. */

        if (ACPI_SUCCESS(acpi_bus_check_add(handle, true, &device)))
                acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
                                    acpi_bus_check_add_1, NULL, NULL,
                                    (void **)&device);

        if (!device)
                return -ENODEV;

        /*
         * Set up ACPI _CRS CSI-2 software nodes using information extracted
         * from the _CRS CSI-2 resource descriptors during the ACPI namespace
         * walk above and MIPI DisCo for Imaging device properties.
         */
        acpi_mipi_scan_crs_csi2();
        acpi_mipi_init_crs_csi2_swnodes();

        acpi_bus_attach(device, (void *)true);

        /* Pass 2: Enumerate all of the remaining devices. */

        acpi_scan_postponed();

        acpi_mipi_crs_csi2_cleanup();

        return 0;
}
EXPORT_SYMBOL(acpi_bus_scan);

/**
 * acpi_bus_trim - Detach scan handlers and drivers from ACPI device objects.
 * @adev: Root of the ACPI namespace scope to walk.
 *
 * Must be called under acpi_scan_lock.
 */
void acpi_bus_trim(struct acpi_device *adev)
{
        uintptr_t flags = 0;

        acpi_scan_check_and_detach(adev, (void *)flags);
}
EXPORT_SYMBOL_GPL(acpi_bus_trim);

int acpi_bus_register_early_device(int type)
{
        struct acpi_device *device = NULL;
        int result;

        result = acpi_add_single_object(&device, NULL, type, false);
        if (result)
                return result;

        acpi_default_enumeration(device);
        return 0;
}
EXPORT_SYMBOL_GPL(acpi_bus_register_early_device);

static void acpi_bus_add_fixed_device_object(enum acpi_bus_device_type type)
{
        struct acpi_device *adev = NULL;

        acpi_add_single_object(&adev, NULL, type, false);
        if (adev)
                acpi_default_enumeration(adev);
}

static void acpi_bus_scan_fixed(void)
{
        if (!(acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON))
                acpi_bus_add_fixed_device_object(ACPI_BUS_TYPE_POWER_BUTTON);

        if (!(acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON))
                acpi_bus_add_fixed_device_object(ACPI_BUS_TYPE_SLEEP_BUTTON);
}

static void __init acpi_get_spcr_uart_addr(void)
{
        acpi_status status;
        struct acpi_table_spcr *spcr_ptr;

        status = acpi_get_table(ACPI_SIG_SPCR, 0,
                                (struct acpi_table_header **)&spcr_ptr);
        if (ACPI_FAILURE(status)) {
                pr_warn("STAO table present, but SPCR is missing\n");
                return;
        }

        spcr_uart_addr = spcr_ptr->serial_port.address;
        acpi_put_table((struct acpi_table_header *)spcr_ptr);
}

static bool acpi_scan_initialized;

void __init acpi_scan_init(void)
{
        acpi_status status;
        struct acpi_table_stao *stao_ptr;

        acpi_pci_root_init();
        acpi_pci_link_init();
        acpi_processor_init();
        acpi_platform_init();
        acpi_lpss_init();
        acpi_apd_init();
        acpi_cmos_rtc_init();
        acpi_container_init();
        acpi_memory_hotplug_init();
        acpi_watchdog_init();
        acpi_pnp_init();
        acpi_power_resources_init();
        acpi_init_lpit();

        acpi_scan_add_handler(&generic_device_handler);

        /*
         * If there is STAO table, check whether it needs to ignore the UART
         * device in SPCR table.
         */
        status = acpi_get_table(ACPI_SIG_STAO, 0,
                                (struct acpi_table_header **)&stao_ptr);
        if (ACPI_SUCCESS(status)) {
                if (stao_ptr->header.length > sizeof(struct acpi_table_stao))
                        pr_info("STAO Name List not yet supported.\n");

                if (stao_ptr->ignore_uart)
                        acpi_get_spcr_uart_addr();

                acpi_put_table((struct acpi_table_header *)stao_ptr);
        }

        acpi_gpe_apply_masked_gpes();
        acpi_update_all_gpes();

        /*
         * Although we call __add_memory() that is documented to require the
         * device_hotplug_lock, it is not necessary here because this is an
         * early code when userspace or any other code path cannot trigger
         * hotplug/hotunplug operations.
         */
        mutex_lock(&acpi_scan_lock);
        /*
         * Enumerate devices in the ACPI namespace.
         */
        if (acpi_bus_scan(ACPI_ROOT_OBJECT))
                goto unlock;

        acpi_root = acpi_fetch_acpi_dev(ACPI_ROOT_OBJECT);
        if (!acpi_root)
                goto unlock;

        /* Fixed feature devices do not exist on HW-reduced platform */
        if (!acpi_gbl_reduced_hardware)
                acpi_bus_scan_fixed();

        acpi_turn_off_unused_power_resources();

        acpi_scan_initialized = true;

unlock:
        mutex_unlock(&acpi_scan_lock);
}

static struct acpi_probe_entry *ape;
static int acpi_probe_count;
static DEFINE_MUTEX(acpi_probe_mutex);

static int __init acpi_match_madt(union acpi_subtable_headers *header,
                                  const unsigned long end)
{
        if (!ape->subtable_valid || ape->subtable_valid(&header->common, ape))
                if (!ape->probe_subtbl(header, end))
                        acpi_probe_count++;

        return 0;
}

void __weak arch_sort_irqchip_probe(struct acpi_probe_entry *ap_head, int nr) { }

int __init __acpi_probe_device_table(struct acpi_probe_entry *ap_head, int nr)
{
        int count = 0;

        if (acpi_disabled)
                return 0;

        mutex_lock(&acpi_probe_mutex);
        arch_sort_irqchip_probe(ap_head, nr);
        for (ape = ap_head; nr; ape++, nr--) {
                if (ACPI_COMPARE_NAMESEG(ACPI_SIG_MADT, ape->id)) {
                        acpi_probe_count = 0;
                        acpi_table_parse_madt(ape->type, acpi_match_madt, 0);
                        count += acpi_probe_count;
                } else {
                        int res;
                        res = acpi_table_parse(ape->id, ape->probe_table);
                        if (!res)
                                count++;
                }
        }
        mutex_unlock(&acpi_probe_mutex);

        return count;
}

static void acpi_table_events_fn(struct work_struct *work)
{
        acpi_scan_lock_acquire();
        acpi_bus_scan(ACPI_ROOT_OBJECT);
        acpi_scan_lock_release();

        kfree(work);
}

void acpi_scan_table_notify(void)
{
        struct work_struct *work;

        if (!acpi_scan_initialized)
                return;

        work = kmalloc_obj(*work);
        if (!work)
                return;

        INIT_WORK(work, acpi_table_events_fn);
        schedule_work(work);
}

int acpi_reconfig_notifier_register(struct notifier_block *nb)
{
        return blocking_notifier_chain_register(&acpi_reconfig_chain, nb);
}
EXPORT_SYMBOL(acpi_reconfig_notifier_register);

int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
{
        return blocking_notifier_chain_unregister(&acpi_reconfig_chain, nb);
}
EXPORT_SYMBOL(acpi_reconfig_notifier_unregister);














































































    2 




    2 






    2 

   24 





    2 



   21 



    3 





    2 








1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __NET_GUE_H
#define __NET_GUE_H

/* Definitions for the GUE header, standard and private flags, lengths
 * of optional fields are below.
 *
 * Diagram of GUE header:
 *
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |Ver|C|  Hlen   | Proto/ctype   |        Standard flags       |P|
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |                                                               |
 * ~                      Fields (optional)                        ~
 * |                                                               |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |            Private flags (optional, P bit is set)             |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |                                                               |
 * ~                   Private fields (optional)                   ~
 * |                                                               |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *
 * C bit indicates control message when set, data message when unset.
 * For a control message, proto/ctype is interpreted as a type of
 * control message. For data messages, proto/ctype is the IP protocol
 * of the next header.
 *
 * P bit indicates private flags field is present. The private flags
 * may refer to options placed after this field.
 */

#include <asm/byteorder.h>
#include <linux/types.h>

struct guehdr {
        union {
                struct {
#if defined(__LITTLE_ENDIAN_BITFIELD)
                        __u8        hlen:5,
                                control:1,
                                version:2;
#elif defined (__BIG_ENDIAN_BITFIELD)
                        __u8        version:2,
                                control:1,
                                hlen:5;
#else
#error  "Please fix <asm/byteorder.h>"
#endif
                        __u8        proto_ctype;
                        __be16        flags;
                };
                __be32        word;
        };
};

/* Standard flags in GUE header */

#define GUE_FLAG_PRIV        htons(1<<0)        /* Private flags are in options */
#define GUE_LEN_PRIV        4

#define GUE_FLAGS_ALL        (GUE_FLAG_PRIV)

/* Private flags in the private option extension */

#define GUE_PFLAG_REMCSUM        htonl(1U << 31)
#define GUE_PLEN_REMCSUM        4

#define GUE_PFLAGS_ALL        (GUE_PFLAG_REMCSUM)

/* Functions to compute options length corresponding to flags.
 * If we ever have a lot of flags this can be potentially be
 * converted to a more optimized algorithm (table lookup
 * for instance).
 */
static inline size_t guehdr_flags_len(__be16 flags)
{
        return ((flags & GUE_FLAG_PRIV) ? GUE_LEN_PRIV : 0);
}

static inline size_t guehdr_priv_flags_len(__be32 flags)
{
        return (flags & GUE_PFLAG_REMCSUM) ? GUE_PLEN_REMCSUM : 0;
}

/* Validate standard and private flags. Returns non-zero (meaning invalid)
 * if there is an unknown standard or private flags, or the options length for
 * the flags exceeds the options length specific in hlen of the GUE header.
 */
static inline int validate_gue_flags(struct guehdr *guehdr, size_t optlen)
{
        __be16 flags = guehdr->flags;
        size_t len;

        if (flags & ~GUE_FLAGS_ALL)
                return 1;

        len = guehdr_flags_len(flags);
        if (len > optlen)
                return 1;

        if (flags & GUE_FLAG_PRIV) {
                /* Private flags are last four bytes accounted in
                 * guehdr_flags_len
                 */
                __be32 pflags = *(__be32 *)((void *)&guehdr[1] +
                                            len - GUE_LEN_PRIV);

                if (pflags & ~GUE_PFLAGS_ALL)
                        return 1;

                len += guehdr_priv_flags_len(pflags);
                if (len > optlen)
                        return 1;
        }

        return 0;
}

#endif

























   13 


   13 
   13 

    8 











    8 










    2 


    2 











    4 
    3 




    4 


    4 



    4 
    2 


    1 


















    3 
    4 






    3 




    3 

    3 


    3 

    3 
















    4 
    4 
    3 






    4 



    3 


    4 


    2 
    2 
    2 





    1 

    4 



    4 

    4 













    1 






    1 


    1 

















    1 


    1 









    5 
    5 
    1 






    5 



    2 


    1 











    5 



    1 
    1 
    2 










    1 





    1 




    1 




    1 

    1 







    5 

    5 





    4 


    5 



    1 





    3 



    3 


    1 






    1 








































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
// SPDX-License-Identifier: GPL-2.0
/*
 * cfg80211 wext compat for managed mode.
 *
 * Copyright 2009        Johannes Berg <johannes@sipsolutions.net>
 * Copyright (C) 2009, 2020-2023 Intel Corporation
 */

#include <linux/export.h>
#include <linux/etherdevice.h>
#include <linux/if_arp.h>
#include <linux/slab.h>
#include <net/cfg80211.h>
#include <net/cfg80211-wext.h>
#include "wext-compat.h"
#include "nl80211.h"

int cfg80211_mgd_wext_connect(struct cfg80211_registered_device *rdev,
                              struct wireless_dev *wdev)
{
        struct cfg80211_cached_keys *ck = NULL;
        const u8 *prev_bssid = NULL;
        int err, i;

        ASSERT_RTNL();
        lockdep_assert_wiphy(wdev->wiphy);

        if (!netif_running(wdev->netdev))
                return 0;

        wdev->wext.connect.ie = wdev->wext.ie;
        wdev->wext.connect.ie_len = wdev->wext.ie_len;

        /* Use default background scan period */
        wdev->wext.connect.bg_scan_period = -1;

        if (wdev->wext.keys) {
                wdev->wext.keys->def = wdev->wext.default_key;
                if (wdev->wext.default_key != -1)
                        wdev->wext.connect.privacy = true;
        }

        if (!wdev->wext.connect.ssid_len)
                return 0;

        if (wdev->wext.keys && wdev->wext.keys->def != -1) {
                ck = kmemdup(wdev->wext.keys, sizeof(*ck), GFP_KERNEL);
                if (!ck)
                        return -ENOMEM;
                for (i = 0; i < 4; i++)
                        ck->params[i].key = ck->data[i];
        }

        if (wdev->wext.prev_bssid_valid)
                prev_bssid = wdev->wext.prev_bssid;

        err = cfg80211_connect(rdev, wdev->netdev,
                               &wdev->wext.connect, ck, prev_bssid);
        if (err)
                kfree_sensitive(ck);

        return err;
}

int cfg80211_mgd_wext_siwfreq(struct net_device *dev,
                              struct iw_request_info *info,
                              struct iw_freq *wextfreq, char *extra)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct cfg80211_registered_device *rdev = wiphy_to_rdev(wdev->wiphy);
        struct ieee80211_channel *chan = NULL;
        int err, freq;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        freq = cfg80211_wext_freq(wextfreq);
        if (freq < 0)
                return freq;

        if (freq) {
                chan = ieee80211_get_channel(wdev->wiphy, freq);
                if (!chan)
                        return -EINVAL;
                if (chan->flags & IEEE80211_CHAN_DISABLED)
                        return -EINVAL;
        }

        if (wdev->conn) {
                bool event = true;

                if (wdev->wext.connect.channel == chan)
                        return 0;

                /* if SSID set, we'll try right again, avoid event */
                if (wdev->wext.connect.ssid_len)
                        event = false;
                err = cfg80211_disconnect(rdev, dev,
                                          WLAN_REASON_DEAUTH_LEAVING, event);
                if (err)
                        return err;
        }

        wdev->wext.connect.channel = chan;
        return cfg80211_mgd_wext_connect(rdev, wdev);
}

int cfg80211_mgd_wext_giwfreq(struct net_device *dev,
                              struct iw_request_info *info,
                              struct iw_freq *freq, char *extra)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct ieee80211_channel *chan = NULL;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        if (wdev->valid_links)
                return -EOPNOTSUPP;

        if (wdev->links[0].client.current_bss)
                chan = wdev->links[0].client.current_bss->pub.channel;
        else if (wdev->wext.connect.channel)
                chan = wdev->wext.connect.channel;

        if (chan) {
                freq->m = chan->center_freq;
                freq->e = 6;
                return 0;
        }

        /* no channel if not joining */
        return -EINVAL;
}

int cfg80211_mgd_wext_siwessid(struct net_device *dev,
                               struct iw_request_info *info,
                               struct iw_point *data, char *ssid)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct cfg80211_registered_device *rdev = wiphy_to_rdev(wdev->wiphy);
        size_t len = data->length;
        int err;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        if (!data->flags)
                len = 0;

        /* iwconfig uses nul termination in SSID.. */
        if (len > 0 && ssid[len - 1] == '\0')
                len--;

        if (wdev->conn) {
                bool event = true;

                if (wdev->wext.connect.ssid && len &&
                    len == wdev->wext.connect.ssid_len &&
                    memcmp(wdev->wext.connect.ssid, ssid, len) == 0)
                        return 0;

                /* if SSID set now, we'll try to connect, avoid event */
                if (len)
                        event = false;
                err = cfg80211_disconnect(rdev, dev,
                                          WLAN_REASON_DEAUTH_LEAVING, event);
                if (err)
                        return err;
        }

        wdev->wext.prev_bssid_valid = false;
        wdev->wext.connect.ssid = wdev->wext.ssid;
        memcpy(wdev->wext.ssid, ssid, len);
        wdev->wext.connect.ssid_len = len;

        wdev->wext.connect.crypto.control_port = false;
        wdev->wext.connect.crypto.control_port_ethertype =
                                        cpu_to_be16(ETH_P_PAE);

        return cfg80211_mgd_wext_connect(rdev, wdev);
}

int cfg80211_mgd_wext_giwessid(struct net_device *dev,
                               struct iw_request_info *info,
                               struct iw_point *data, char *ssid)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        int ret = 0;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        if (wdev->valid_links)
                return -EINVAL;

        data->flags = 0;

        if (wdev->links[0].client.current_bss) {
                const struct element *ssid_elem;

                rcu_read_lock();
                ssid_elem = ieee80211_bss_get_elem(
                                &wdev->links[0].client.current_bss->pub,
                                WLAN_EID_SSID);
                if (ssid_elem) {
                        data->flags = 1;
                        data->length = ssid_elem->datalen;
                        if (data->length > IW_ESSID_MAX_SIZE)
                                ret = -EINVAL;
                        else
                                memcpy(ssid, ssid_elem->data, data->length);
                }
                rcu_read_unlock();
        } else if (wdev->wext.connect.ssid && wdev->wext.connect.ssid_len) {
                data->flags = 1;
                data->length = wdev->wext.connect.ssid_len;
                memcpy(ssid, wdev->wext.connect.ssid, data->length);
        }

        return ret;
}

int cfg80211_mgd_wext_siwap(struct net_device *dev,
                            struct iw_request_info *info,
                            struct sockaddr *ap_addr, char *extra)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct cfg80211_registered_device *rdev = wiphy_to_rdev(wdev->wiphy);
        u8 *bssid = ap_addr->sa_data;
        int err;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        if (ap_addr->sa_family != ARPHRD_ETHER)
                return -EINVAL;

        /* automatic mode */
        if (is_zero_ether_addr(bssid) || is_broadcast_ether_addr(bssid))
                bssid = NULL;

        if (wdev->conn) {
                /* both automatic */
                if (!bssid && !wdev->wext.connect.bssid)
                        return 0;

                /* fixed already - and no change */
                if (wdev->wext.connect.bssid && bssid &&
                    ether_addr_equal(bssid, wdev->wext.connect.bssid))
                        return 0;

                err = cfg80211_disconnect(rdev, dev,
                                          WLAN_REASON_DEAUTH_LEAVING, false);
                if (err)
                        return err;
        }

        if (bssid) {
                memcpy(wdev->wext.bssid, bssid, ETH_ALEN);
                wdev->wext.connect.bssid = wdev->wext.bssid;
        } else
                wdev->wext.connect.bssid = NULL;

        return cfg80211_mgd_wext_connect(rdev, wdev);
}

int cfg80211_mgd_wext_giwap(struct net_device *dev,
                            struct iw_request_info *info,
                            struct sockaddr *ap_addr, char *extra)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;

        /* call only for station! */
        if (WARN_ON(wdev->iftype != NL80211_IFTYPE_STATION))
                return -EINVAL;

        ap_addr->sa_family = ARPHRD_ETHER;

        if (wdev->valid_links)
                return -EOPNOTSUPP;

        if (wdev->links[0].client.current_bss)
                memcpy(ap_addr->sa_data,
                       wdev->links[0].client.current_bss->pub.bssid,
                       ETH_ALEN);
        else
                eth_zero_addr(ap_addr->sa_data);

        return 0;
}

int cfg80211_wext_siwgenie(struct net_device *dev,
                           struct iw_request_info *info,
                           union iwreq_data *wrqu, char *extra)
{
        struct iw_point *data = &wrqu->data;
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct cfg80211_registered_device *rdev = wiphy_to_rdev(wdev->wiphy);
        int ie_len = data->length;
        u8 *ie = extra;

        if (wdev->iftype != NL80211_IFTYPE_STATION)
                return -EOPNOTSUPP;

        if (!ie_len)
                ie = NULL;

        guard(wiphy)(wdev->wiphy);

        /* no change */
        if (wdev->wext.ie_len == ie_len &&
            memcmp(wdev->wext.ie, ie, ie_len) == 0)
                return 0;

        if (ie_len) {
                const struct element *elem;

                for_each_element(elem, extra, ie_len) {
                        /* nothing */
                }

                if (!for_each_element_completed(elem, extra, ie_len))
                        return -EINVAL;

                ie = kmemdup(extra, ie_len, GFP_KERNEL);
                if (!ie)
                        return -ENOMEM;
        } else {
                ie = NULL;
        }

        kfree(wdev->wext.ie);
        wdev->wext.ie = ie;
        wdev->wext.ie_len = ie_len;

        if (wdev->conn)
                return cfg80211_disconnect(rdev, dev,
                                           WLAN_REASON_DEAUTH_LEAVING, false);

        /* userspace better not think we'll reconnect */
        return 0;
}

int cfg80211_wext_siwmlme(struct net_device *dev,
                          struct iw_request_info *info,
                          union iwreq_data *wrqu, char *extra)
{
        struct wireless_dev *wdev = dev->ieee80211_ptr;
        struct iw_mlme *mlme = (struct iw_mlme *)extra;
        struct cfg80211_registered_device *rdev;

        if (!wdev)
                return -EOPNOTSUPP;

        rdev = wiphy_to_rdev(wdev->wiphy);

        if (wdev->iftype != NL80211_IFTYPE_STATION)
                return -EINVAL;

        if (mlme->addr.sa_family != ARPHRD_ETHER)
                return -EINVAL;

        guard(wiphy)(&rdev->wiphy);

        switch (mlme->cmd) {
        case IW_MLME_DEAUTH:
        case IW_MLME_DISASSOC:
                return cfg80211_disconnect(rdev, dev, mlme->reason_code, true);
        default:
                return -EOPNOTSUPP;
        }
}



















    6 














   16 



































   14 






    8 











    8 













    8 



    8 



    8 
    2 


    2 
    1 

    2 


    2 












    6 
    5 


    5 






    5 







    4 


    5 



    5 


    5 



    5 







    5 


    5 

    6 





    6 









    7 











    7 
    7 




    5 


    5 






    5 


    5 


    7 




    6 


    7 








    6 






























    6 
    4 


    2 
    1 
    6 


    3 











    6 






    6 












































    9 


    9 




    9 












    9 



    2 




    9 


    9 



    9 


    9 






    9 
    8 



























    9 

    9 











    9 
    9 




    9 















    9 
    3 


    9 












    8 
    9 






    9 




    9 






    9 






    9 

    9 






    9 


    9 












   10 











    9 
   10 

   10 

    4 
    9 
    9 
    9 





    9 














    9 




    9 

    5 




    9 
    9 





    9 




    9 






    9 









    5 
    5 



    5 









    5 











    9 







   15 
    1 

    1 




   14 







   14 


    4 

    4 


    3 
































   16 







   15 



   14 











   14 



















   14 


   13 






   13 

   13 

   13 

   12 









   10 

   10 
   10 

   10 





    6 


   13 
   16 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2017 Oracle.  All Rights Reserved.
 *
 * Author: Darrick J. Wong <darrick.wong@oracle.com>
 */
#include "ext4.h"
#include <linux/fsmap.h>
#include "fsmap.h"
#include "mballoc.h"
#include <linux/sort.h>
#include <linux/list_sort.h>
#include <trace/events/ext4.h>

/* Convert an ext4_fsmap to an fsmap. */
void ext4_fsmap_from_internal(struct super_block *sb, struct fsmap *dest,
                              struct ext4_fsmap *src)
{
        dest->fmr_device = src->fmr_device;
        dest->fmr_flags = src->fmr_flags;
        dest->fmr_physical = src->fmr_physical << sb->s_blocksize_bits;
        dest->fmr_owner = src->fmr_owner;
        dest->fmr_offset = 0;
        dest->fmr_length = src->fmr_length << sb->s_blocksize_bits;
        dest->fmr_reserved[0] = 0;
        dest->fmr_reserved[1] = 0;
        dest->fmr_reserved[2] = 0;
}

/* Convert an fsmap to an ext4_fsmap. */
void ext4_fsmap_to_internal(struct super_block *sb, struct ext4_fsmap *dest,
                            struct fsmap *src)
{
        dest->fmr_device = src->fmr_device;
        dest->fmr_flags = src->fmr_flags;
        dest->fmr_physical = src->fmr_physical >> sb->s_blocksize_bits;
        dest->fmr_owner = src->fmr_owner;
        dest->fmr_length = src->fmr_length >> sb->s_blocksize_bits;
}

/* getfsmap query state */
struct ext4_getfsmap_info {
        struct ext4_fsmap_head        *gfi_head;
        ext4_fsmap_format_t        gfi_formatter;        /* formatting fn */
        void                        *gfi_format_arg;/* format buffer */
        ext4_fsblk_t                gfi_next_fsblk;        /* next fsblock we expect */
        u32                        gfi_dev;        /* device id */
        ext4_group_t                gfi_agno;        /* bg number, if applicable */
        struct ext4_fsmap        gfi_low;        /* low rmap key */
        struct ext4_fsmap        gfi_high;        /* high rmap key */
        struct ext4_fsmap        gfi_lastfree;        /* free ext at end of last bg */
        struct list_head        gfi_meta_list;        /* fixed metadata list */
        bool                        gfi_last;        /* last extent? */
};

/* Associate a device with a getfsmap handler. */
struct ext4_getfsmap_dev {
        int                        (*gfd_fn)(struct super_block *sb,
                                      struct ext4_fsmap *keys,
                                      struct ext4_getfsmap_info *info);
        u32                        gfd_dev;
};

/* Compare two getfsmap device handlers. */
static int ext4_getfsmap_dev_compare(const void *p1, const void *p2)
{
        const struct ext4_getfsmap_dev *d1 = p1;
        const struct ext4_getfsmap_dev *d2 = p2;

        return d1->gfd_dev - d2->gfd_dev;
}

/* Compare a record against our starting point */
static bool ext4_getfsmap_rec_before_low_key(struct ext4_getfsmap_info *info,
                                             struct ext4_fsmap *rec)
{
        return rec->fmr_physical + rec->fmr_length <=
               info->gfi_low.fmr_physical;
}

/*
 * Format a reverse mapping for getfsmap, having translated rm_startblock
 * into the appropriate daddr units.
 */
static int ext4_getfsmap_helper(struct super_block *sb,
                                struct ext4_getfsmap_info *info,
                                struct ext4_fsmap *rec)
{
        struct ext4_fsmap fmr;
        struct ext4_sb_info *sbi = EXT4_SB(sb);
        ext4_fsblk_t rec_fsblk = rec->fmr_physical;
        ext4_group_t agno;
        ext4_grpblk_t cno;
        int error;

        if (fatal_signal_pending(current))
                return -EINTR;

        /*
         * Filter out records that start before our startpoint, if the
         * caller requested that.
         */
        if (ext4_getfsmap_rec_before_low_key(info, rec)) {
                rec_fsblk += rec->fmr_length;
                if (info->gfi_next_fsblk < rec_fsblk)
                        info->gfi_next_fsblk = rec_fsblk;
                return EXT4_QUERY_RANGE_CONTINUE;
        }

        /* Are we just counting mappings? */
        if (info->gfi_head->fmh_count == 0) {
                if (info->gfi_head->fmh_entries == UINT_MAX)
                        return EXT4_QUERY_RANGE_ABORT;

                if (rec_fsblk > info->gfi_next_fsblk)
                        info->gfi_head->fmh_entries++;

                if (info->gfi_last)
                        return EXT4_QUERY_RANGE_CONTINUE;

                info->gfi_head->fmh_entries++;

                rec_fsblk += rec->fmr_length;
                if (info->gfi_next_fsblk < rec_fsblk)
                        info->gfi_next_fsblk = rec_fsblk;
                return EXT4_QUERY_RANGE_CONTINUE;
        }

        /*
         * If the record starts past the last physical block we saw,
         * then we've found a gap.  Report the gap as being owned by
         * whatever the caller specified is the missing owner.
         */
        if (rec_fsblk > info->gfi_next_fsblk) {
                if (info->gfi_head->fmh_entries >= info->gfi_head->fmh_count)
                        return EXT4_QUERY_RANGE_ABORT;

                ext4_get_group_no_and_offset(sb, info->gfi_next_fsblk,
                                &agno, &cno);
                trace_ext4_fsmap_mapping(sb, info->gfi_dev, agno,
                                EXT4_C2B(sbi, cno),
                                rec_fsblk - info->gfi_next_fsblk,
                                EXT4_FMR_OWN_UNKNOWN);

                fmr.fmr_device = info->gfi_dev;
                fmr.fmr_physical = info->gfi_next_fsblk;
                fmr.fmr_owner = EXT4_FMR_OWN_UNKNOWN;
                fmr.fmr_length = rec_fsblk - info->gfi_next_fsblk;
                fmr.fmr_flags = FMR_OF_SPECIAL_OWNER;
                error = info->gfi_formatter(&fmr, info->gfi_format_arg);
                if (error)
                        return error;
                info->gfi_head->fmh_entries++;
        }

        if (info->gfi_last)
                goto out;

        /* Fill out the extent we found */
        if (info->gfi_head->fmh_entries >= info->gfi_head->fmh_count)
                return EXT4_QUERY_RANGE_ABORT;

        ext4_get_group_no_and_offset(sb, rec_fsblk, &agno, &cno);
        trace_ext4_fsmap_mapping(sb, info->gfi_dev, agno, EXT4_C2B(sbi, cno),
                        rec->fmr_length, rec->fmr_owner);

        fmr.fmr_device = info->gfi_dev;
        fmr.fmr_physical = rec_fsblk;
        fmr.fmr_owner = rec->fmr_owner;
        fmr.fmr_flags = FMR_OF_SPECIAL_OWNER;
        fmr.fmr_length = rec->fmr_length;
        error = info->gfi_formatter(&fmr, info->gfi_format_arg);
        if (error)
                return error;
        info->gfi_head->fmh_entries++;

out:
        rec_fsblk += rec->fmr_length;
        if (info->gfi_next_fsblk < rec_fsblk)
                info->gfi_next_fsblk = rec_fsblk;
        return EXT4_QUERY_RANGE_CONTINUE;
}

static inline ext4_fsblk_t ext4_fsmap_next_pblk(struct ext4_fsmap *fmr)
{
        return fmr->fmr_physical + fmr->fmr_length;
}

static int ext4_getfsmap_meta_helper(struct super_block *sb,
                                     ext4_group_t agno, ext4_grpblk_t start,
                                     ext4_grpblk_t len, void *priv)
{
        struct ext4_getfsmap_info *info = priv;
        struct ext4_fsmap *p;
        struct ext4_fsmap *tmp;
        struct ext4_sb_info *sbi = EXT4_SB(sb);
        ext4_fsblk_t fsb, fs_start, fs_end;
        int error;

        fs_start = fsb = (EXT4_C2B(sbi, start) +
                          ext4_group_first_block_no(sb, agno));
        fs_end = fs_start + EXT4_C2B(sbi, len);

        /*
         * Return relevant extents from the meta_list. We emit all extents that
         * partially/fully overlap with the query range
         */
        list_for_each_entry_safe(p, tmp, &info->gfi_meta_list, fmr_list) {
                if (p->fmr_physical + p->fmr_length <= info->gfi_next_fsblk) {
                        list_del(&p->fmr_list);
                        kfree(p);
                        continue;
                }
                if (p->fmr_physical <= fs_end &&
                    p->fmr_physical + p->fmr_length > fs_start) {
                        /* Emit the retained free extent record if present */
                        if (info->gfi_lastfree.fmr_owner) {
                                error = ext4_getfsmap_helper(sb, info,
                                                        &info->gfi_lastfree);
                                if (error)
                                        return error;
                                info->gfi_lastfree.fmr_owner = 0;
                        }
                        error = ext4_getfsmap_helper(sb, info, p);
                        if (error)
                                return error;
                        fsb = p->fmr_physical + p->fmr_length;
                        if (info->gfi_next_fsblk < fsb)
                                info->gfi_next_fsblk = fsb;
                        list_del(&p->fmr_list);
                        kfree(p);
                        continue;
                }
        }
        if (info->gfi_next_fsblk < fsb)
                info->gfi_next_fsblk = fsb;

        return 0;
}


/* Transform a blockgroup's free record into a fsmap */
static int ext4_getfsmap_datadev_helper(struct super_block *sb,
                                        ext4_group_t agno, ext4_grpblk_t start,
                                        ext4_grpblk_t len, void *priv)
{
        struct ext4_fsmap irec;
        struct ext4_getfsmap_info *info = priv;
        struct ext4_fsmap *p;
        struct ext4_fsmap *tmp;
        struct ext4_sb_info *sbi = EXT4_SB(sb);
        ext4_fsblk_t fsb;
        ext4_fsblk_t fslen;
        int error;

        fsb = (EXT4_C2B(sbi, start) + ext4_group_first_block_no(sb, agno));
        fslen = EXT4_C2B(sbi, len);

        /* If the retained free extent record is set... */
        if (info->gfi_lastfree.fmr_owner) {
                /* ...and abuts this one, lengthen it and return. */
                if (ext4_fsmap_next_pblk(&info->gfi_lastfree) == fsb) {
                        info->gfi_lastfree.fmr_length += fslen;
                        return 0;
                }

                /*
                 * There's a gap between the two free extents; emit the
                 * retained extent prior to merging the meta_list.
                 */
                error = ext4_getfsmap_helper(sb, info, &info->gfi_lastfree);
                if (error)
                        return error;
                info->gfi_lastfree.fmr_owner = 0;
        }

        /* Merge in any relevant extents from the meta_list */
        list_for_each_entry_safe(p, tmp, &info->gfi_meta_list, fmr_list) {
                if (p->fmr_physical + p->fmr_length <= info->gfi_next_fsblk) {
                        list_del(&p->fmr_list);
                        kfree(p);
                } else if (p->fmr_physical < fsb) {
                        error = ext4_getfsmap_helper(sb, info, p);
                        if (error)
                                return error;

                        list_del(&p->fmr_list);
                        kfree(p);
                }
        }

        irec.fmr_device = 0;
        irec.fmr_physical = fsb;
        irec.fmr_length = fslen;
        irec.fmr_owner = EXT4_FMR_OWN_FREE;
        irec.fmr_flags = 0;

        /* If this is a free extent at the end of a bg, buffer it. */
        if (ext4_fsmap_next_pblk(&irec) ==
                        ext4_group_first_block_no(sb, agno + 1)) {
                info->gfi_lastfree = irec;
                return 0;
        }

        /* Otherwise, emit it */
        return ext4_getfsmap_helper(sb, info, &irec);
}

/* Execute a getfsmap query against the log device. */
static int ext4_getfsmap_logdev(struct super_block *sb, struct ext4_fsmap *keys,
                                struct ext4_getfsmap_info *info)
{
        journal_t *journal = EXT4_SB(sb)->s_journal;
        struct ext4_fsmap irec;

        /* Set up search keys */
        info->gfi_low = keys[0];
        info->gfi_low.fmr_length = 0;

        memset(&info->gfi_high, 0xFF, sizeof(info->gfi_high));

        trace_ext4_fsmap_low_key(sb, info->gfi_dev, 0,
                        info->gfi_low.fmr_physical,
                        info->gfi_low.fmr_length,
                        info->gfi_low.fmr_owner);

        trace_ext4_fsmap_high_key(sb, info->gfi_dev, 0,
                        info->gfi_high.fmr_physical,
                        info->gfi_high.fmr_length,
                        info->gfi_high.fmr_owner);

        if (keys[0].fmr_physical > 0)
                return 0;

        /* Fabricate an rmap entry for the external log device. */
        irec.fmr_physical = journal->j_blk_offset;
        irec.fmr_length = journal->j_total_len;
        irec.fmr_owner = EXT4_FMR_OWN_LOG;
        irec.fmr_flags = 0;

        return ext4_getfsmap_helper(sb, info, &irec);
}

/* Helper to fill out an ext4_fsmap. */
static inline int ext4_getfsmap_fill(struct list_head *meta_list,
                                     ext4_fsblk_t fsb, ext4_fsblk_t len,
                                     uint64_t owner)
{
        struct ext4_fsmap *fsm;

        fsm = kmalloc_obj(*fsm, GFP_NOFS);
        if (!fsm)
                return -ENOMEM;
        fsm->fmr_device = 0;
        fsm->fmr_flags = 0;
        fsm->fmr_physical = fsb;
        fsm->fmr_owner = owner;
        fsm->fmr_length = len;
        list_add_tail(&fsm->fmr_list, meta_list);

        return 0;
}

/*
 * This function returns the number of file system metadata blocks at
 * the beginning of a block group, including the reserved gdt blocks.
 */
static unsigned int ext4_getfsmap_find_sb(struct super_block *sb,
                                          ext4_group_t agno,
                                          struct list_head *meta_list)
{
        struct ext4_sb_info *sbi = EXT4_SB(sb);
        ext4_fsblk_t fsb = ext4_group_first_block_no(sb, agno);
        ext4_fsblk_t len;
        unsigned long first_meta_bg = le32_to_cpu(sbi->s_es->s_first_meta_bg);
        unsigned long metagroup = agno / EXT4_DESC_PER_BLOCK(sb);
        int error;

        /* Record the superblock. */
        if (ext4_bg_has_super(sb, agno)) {
                error = ext4_getfsmap_fill(meta_list, fsb, 1, EXT4_FMR_OWN_FS);
                if (error)
                        return error;
                fsb++;
        }

        /* Record the group descriptors. */
        len = ext4_bg_num_gdb(sb, agno);
        if (!len)
                return 0;
        error = ext4_getfsmap_fill(meta_list, fsb, len,
                                   EXT4_FMR_OWN_GDT);
        if (error)
                return error;
        fsb += len;

        /* Reserved GDT blocks */
        if (!ext4_has_feature_meta_bg(sb) || metagroup < first_meta_bg) {
                len = le16_to_cpu(sbi->s_es->s_reserved_gdt_blocks);

                /*
                 * mkfs.ext4 can set s_reserved_gdt_blocks as 0 in some cases,
                 * check for that.
                 */
                if (!len)
                        return 0;

                error = ext4_getfsmap_fill(meta_list, fsb, len,
                                           EXT4_FMR_OWN_RESV_GDT);
                if (error)
                        return error;
        }

        return 0;
}

/* Compare two fsmap items. */
static int ext4_getfsmap_compare(void *priv,
                                 const struct list_head *a,
                                 const struct list_head *b)
{
        struct ext4_fsmap *fa;
        struct ext4_fsmap *fb;

        fa = container_of(a, struct ext4_fsmap, fmr_list);
        fb = container_of(b, struct ext4_fsmap, fmr_list);
        if (fa->fmr_physical < fb->fmr_physical)
                return -1;
        else if (fa->fmr_physical > fb->fmr_physical)
                return 1;
        return 0;
}

/* Merge adjacent extents of fixed metadata. */
static void ext4_getfsmap_merge_fixed_metadata(struct list_head *meta_list)
{
        struct ext4_fsmap *p;
        struct ext4_fsmap *prev = NULL;
        struct ext4_fsmap *tmp;

        list_for_each_entry_safe(p, tmp, meta_list, fmr_list) {
                if (!prev) {
                        prev = p;
                        continue;
                }

                if (prev->fmr_owner == p->fmr_owner &&
                    prev->fmr_physical + prev->fmr_length == p->fmr_physical) {
                        prev->fmr_length += p->fmr_length;
                        list_del(&p->fmr_list);
                        kfree(p);
                } else
                        prev = p;
        }
}

/* Free a list of fixed metadata. */
static void ext4_getfsmap_free_fixed_metadata(struct list_head *meta_list)
{
        struct ext4_fsmap *p;
        struct ext4_fsmap *tmp;

        list_for_each_entry_safe(p, tmp, meta_list, fmr_list) {
                list_del(&p->fmr_list);
                kfree(p);
        }
}

/* Find all the fixed metadata in the filesystem. */
static int ext4_getfsmap_find_fixed_metadata(struct super_block *sb,
                                             struct list_head *meta_list)
{
        struct ext4_group_desc *gdp;
        ext4_group_t agno;
        int error;

        INIT_LIST_HEAD(meta_list);

        /* Collect everything. */
        for (agno = 0; agno < EXT4_SB(sb)->s_groups_count; agno++) {
                gdp = ext4_get_group_desc(sb, agno, NULL);
                if (!gdp) {
                        error = -EFSCORRUPTED;
                        goto err;
                }

                /* Superblock & GDT */
                error = ext4_getfsmap_find_sb(sb, agno, meta_list);
                if (error)
                        goto err;

                /* Block bitmap */
                error = ext4_getfsmap_fill(meta_list,
                                           ext4_block_bitmap(sb, gdp), 1,
                                           EXT4_FMR_OWN_BLKBM);
                if (error)
                        goto err;

                /* Inode bitmap */
                error = ext4_getfsmap_fill(meta_list,
                                           ext4_inode_bitmap(sb, gdp), 1,
                                           EXT4_FMR_OWN_INOBM);
                if (error)
                        goto err;

                /* Inodes */
                error = ext4_getfsmap_fill(meta_list,
                                           ext4_inode_table(sb, gdp),
                                           EXT4_SB(sb)->s_itb_per_group,
                                           EXT4_FMR_OWN_INODES);
                if (error)
                        goto err;
        }

        /* Sort the list */
        list_sort(NULL, meta_list, ext4_getfsmap_compare);

        /* Merge adjacent extents */
        ext4_getfsmap_merge_fixed_metadata(meta_list);

        return 0;
err:
        ext4_getfsmap_free_fixed_metadata(meta_list);
        return error;
}

/* Execute a getfsmap query against the buddy bitmaps */
static int ext4_getfsmap_datadev(struct super_block *sb,
                                 struct ext4_fsmap *keys,
                                 struct ext4_getfsmap_info *info)
{
        struct ext4_sb_info *sbi = EXT4_SB(sb);
        ext4_fsblk_t start_fsb;
        ext4_fsblk_t end_fsb;
        ext4_fsblk_t bofs;
        ext4_fsblk_t eofs;
        ext4_group_t start_ag;
        ext4_group_t end_ag;
        ext4_grpblk_t first_cluster;
        ext4_grpblk_t last_cluster;
        struct ext4_fsmap irec;
        int error = 0;

        bofs = le32_to_cpu(sbi->s_es->s_first_data_block);
        eofs = ext4_blocks_count(sbi->s_es);
        if (keys[0].fmr_physical >= eofs)
                return 0;
        else if (keys[0].fmr_physical < bofs)
                keys[0].fmr_physical = bofs;
        if (keys[1].fmr_physical >= eofs)
                keys[1].fmr_physical = eofs - 1;
        if (keys[1].fmr_physical < keys[0].fmr_physical)
                return 0;
        start_fsb = keys[0].fmr_physical;
        end_fsb = keys[1].fmr_physical;

        /* Determine first and last group to examine based on start and end */
        ext4_get_group_no_and_offset(sb, start_fsb, &start_ag, &first_cluster);
        ext4_get_group_no_and_offset(sb, end_fsb, &end_ag, &last_cluster);

        /*
         * Convert the fsmap low/high keys to bg based keys.  Initialize
         * low to the fsmap low key and max out the high key to the end
         * of the bg.
         */
        info->gfi_low = keys[0];
        info->gfi_low.fmr_physical = EXT4_C2B(sbi, first_cluster);
        info->gfi_low.fmr_length = 0;

        memset(&info->gfi_high, 0xFF, sizeof(info->gfi_high));

        /* Assemble a list of all the fixed-location metadata. */
        error = ext4_getfsmap_find_fixed_metadata(sb, &info->gfi_meta_list);
        if (error)
                goto err;

        /* Query each bg */
        for (info->gfi_agno = start_ag;
             info->gfi_agno <= end_ag;
             info->gfi_agno++) {
                /*
                 * Set the bg high key from the fsmap high key if this
                 * is the last bg that we're querying.
                 */
                if (info->gfi_agno == end_ag) {
                        info->gfi_high = keys[1];
                        info->gfi_high.fmr_physical = EXT4_C2B(sbi,
                                        last_cluster);
                        info->gfi_high.fmr_length = 0;
                }

                trace_ext4_fsmap_low_key(sb, info->gfi_dev, info->gfi_agno,
                                info->gfi_low.fmr_physical,
                                info->gfi_low.fmr_length,
                                info->gfi_low.fmr_owner);

                trace_ext4_fsmap_high_key(sb, info->gfi_dev, info->gfi_agno,
                                info->gfi_high.fmr_physical,
                                info->gfi_high.fmr_length,
                                info->gfi_high.fmr_owner);

                error = ext4_mballoc_query_range(sb, info->gfi_agno,
                                EXT4_B2C(sbi, info->gfi_low.fmr_physical),
                                EXT4_B2C(sbi, info->gfi_high.fmr_physical),
                                ext4_getfsmap_meta_helper,
                                ext4_getfsmap_datadev_helper, info);
                if (error)
                        goto err;

                /*
                 * Set the bg low key to the start of the bg prior to
                 * moving on to the next bg.
                 */
                if (info->gfi_agno == start_ag)
                        memset(&info->gfi_low, 0, sizeof(info->gfi_low));
        }

        /* Do we have a retained free extent? */
        if (info->gfi_lastfree.fmr_owner) {
                error = ext4_getfsmap_helper(sb, info, &info->gfi_lastfree);
                if (error)
                        goto err;
        }

        /*
         * The dummy record below will cause ext4_getfsmap_helper() to report
         * any allocated blocks at the end of the range.
         */
        irec.fmr_device = 0;
        irec.fmr_physical = end_fsb + 1;
        irec.fmr_length = 0;
        irec.fmr_owner = EXT4_FMR_OWN_FREE;
        irec.fmr_flags = 0;

        info->gfi_last = true;
        error = ext4_getfsmap_helper(sb, info, &irec);
        if (error)
                goto err;

err:
        ext4_getfsmap_free_fixed_metadata(&info->gfi_meta_list);
        return error;
}

/* Do we recognize the device? */
static bool ext4_getfsmap_is_valid_device(struct super_block *sb,
                                          struct ext4_fsmap *fm)
{
        if (fm->fmr_device == 0 || fm->fmr_device == UINT_MAX ||
            fm->fmr_device == new_encode_dev(sb->s_bdev->bd_dev))
                return true;
        if (EXT4_SB(sb)->s_journal_bdev_file &&
            fm->fmr_device ==
            new_encode_dev(file_bdev(EXT4_SB(sb)->s_journal_bdev_file)->bd_dev))
                return true;
        return false;
}

/* Ensure that the low key is less than the high key. */
static bool ext4_getfsmap_check_keys(struct ext4_fsmap *low_key,
                                     struct ext4_fsmap *high_key)
{
        if (low_key->fmr_device > high_key->fmr_device)
                return false;
        if (low_key->fmr_device < high_key->fmr_device)
                return true;

        if (low_key->fmr_physical > high_key->fmr_physical)
                return false;
        if (low_key->fmr_physical < high_key->fmr_physical)
                return true;

        if (low_key->fmr_owner > high_key->fmr_owner)
                return false;
        if (low_key->fmr_owner < high_key->fmr_owner)
                return true;

        return false;
}

#define EXT4_GETFSMAP_DEVS        2
/*
 * Get filesystem's extents as described in head, and format for
 * output.  Calls formatter to fill the user's buffer until all
 * extents are mapped, until the passed-in head->fmh_count slots have
 * been filled, or until the formatter short-circuits the loop, if it
 * is tracking filled-in extents on its own.
 *
 * Key to Confusion
 * ----------------
 * There are multiple levels of keys and counters at work here:
 * _fsmap_head.fmh_keys                -- low and high fsmap keys passed in;
 *                                    these reflect fs-wide block addrs.
 * dkeys                        -- fmh_keys used to query each device;
 *                                    these are fmh_keys but w/ the low key
 *                                    bumped up by fmr_length.
 * _getfsmap_info.gfi_next_fsblk-- next fs block we expect to see; this
 *                                   is how we detect gaps in the fsmap
 *                                   records and report them.
 * _getfsmap_info.gfi_low/high        -- per-bg low/high keys computed from
 *                                    dkeys; used to query the free space.
 */
int ext4_getfsmap(struct super_block *sb, struct ext4_fsmap_head *head,
                  ext4_fsmap_format_t formatter, void *arg)
{
        struct ext4_fsmap dkeys[2];        /* per-dev keys */
        struct ext4_getfsmap_dev handlers[EXT4_GETFSMAP_DEVS];
        struct ext4_getfsmap_info info = { NULL };
        int i;
        int error = 0;

        if (head->fmh_iflags & ~FMH_IF_VALID)
                return -EINVAL;
        if (!ext4_getfsmap_is_valid_device(sb, &head->fmh_keys[0]) ||
            !ext4_getfsmap_is_valid_device(sb, &head->fmh_keys[1]))
                return -EINVAL;

        head->fmh_entries = 0;

        /* Set up our device handlers. */
        memset(handlers, 0, sizeof(handlers));
        handlers[0].gfd_dev = new_encode_dev(sb->s_bdev->bd_dev);
        handlers[0].gfd_fn = ext4_getfsmap_datadev;
        if (EXT4_SB(sb)->s_journal_bdev_file) {
                handlers[1].gfd_dev = new_encode_dev(
                        file_bdev(EXT4_SB(sb)->s_journal_bdev_file)->bd_dev);
                handlers[1].gfd_fn = ext4_getfsmap_logdev;
        }

        sort(handlers, EXT4_GETFSMAP_DEVS, sizeof(struct ext4_getfsmap_dev),
                        ext4_getfsmap_dev_compare, NULL);

        /*
         * To continue where we left off, we allow userspace to use the
         * last mapping from a previous call as the low key of the next.
         * This is identified by a non-zero length in the low key. We
         * have to increment the low key in this scenario to ensure we
         * don't return the same mapping again, and instead return the
         * very next mapping.
         *
         * Bump the physical offset as there can be no other mapping for
         * the same physical block range.
         */
        dkeys[0] = head->fmh_keys[0];
        dkeys[0].fmr_physical += dkeys[0].fmr_length;
        dkeys[0].fmr_owner = 0;
        dkeys[0].fmr_length = 0;
        memset(&dkeys[1], 0xFF, sizeof(struct ext4_fsmap));

        if (!ext4_getfsmap_check_keys(dkeys, &head->fmh_keys[1]))
                return -EINVAL;

        info.gfi_next_fsblk = head->fmh_keys[0].fmr_physical +
                          head->fmh_keys[0].fmr_length;
        info.gfi_formatter = formatter;
        info.gfi_format_arg = arg;
        info.gfi_head = head;

        /* For each device we support... */
        for (i = 0; i < EXT4_GETFSMAP_DEVS; i++) {
                /* Is this device within the range the user asked for? */
                if (!handlers[i].gfd_fn)
                        continue;
                if (head->fmh_keys[0].fmr_device > handlers[i].gfd_dev)
                        continue;
                if (head->fmh_keys[1].fmr_device < handlers[i].gfd_dev)
                        break;

                /*
                 * If this device number matches the high key, we have
                 * to pass the high key to the handler to limit the
                 * query results.  If the device number exceeds the
                 * low key, zero out the low key so that we get
                 * everything from the beginning.
                 */
                if (handlers[i].gfd_dev == head->fmh_keys[1].fmr_device)
                        dkeys[1] = head->fmh_keys[1];
                if (handlers[i].gfd_dev > head->fmh_keys[0].fmr_device)
                        memset(&dkeys[0], 0, sizeof(struct ext4_fsmap));

                info.gfi_dev = handlers[i].gfd_dev;
                info.gfi_last = false;
                info.gfi_agno = -1;
                error = handlers[i].gfd_fn(sb, dkeys, &info);
                if (error)
                        break;
                info.gfi_next_fsblk = 0;
        }

        head->fmh_oflags = FMH_OF_DEV_T;
        return error;
}





















































































































    6 




    6 
    6 
    6 

    6 























    6 



    6 


































    6 




    6 

    6 









































    4 




    4 
    4 
    4 
    4 

    4 




    4 




    4 



    4 




    4 







    4 






    4 







    4 


    4 







    4 


    4 

















    5 


    5 

    5 





    5 

    5 




    1 
    1 




    1 

    5 


    4 



    4 























































































































































































    5 

    5 



    5 











    5 





    5 





    5 



    5 












    6 

    6 

    6 


























































































































    6 

    6 















    6 









    6 

    5 




    5 
    6 








    3 




























































































    4 

    4 











    4 





    4 


    4 














































































































































    3 



    3 


    3 



    3 




    3 
    2 




    2 
    3 




    3 


















































































    4 





    4 

    4 



    4 








    4 





    4 




    4 


    4 

    4 














    6 


























    4 
    4 




































    4 












































    4 
    4 

























































































    4 



    4 


























































    4 





    4 


































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright (c) International Business Machines Corp., 2006
 * Copyright (c) Nokia Corporation, 2006, 2007
 *
 * Author: Artem Bityutskiy (Битюцкий Артём)
 */

/*
 * UBI input/output sub-system.
 *
 * This sub-system provides a uniform way to work with all kinds of the
 * underlying MTD devices. It also implements handy functions for reading and
 * writing UBI headers.
 *
 * We are trying to have a paranoid mindset and not to trust to what we read
 * from the flash media in order to be more secure and robust. So this
 * sub-system validates every single header it reads from the flash media.
 *
 * Some words about how the eraseblock headers are stored.
 *
 * The erase counter header is always stored at offset zero. By default, the
 * VID header is stored after the EC header at the closest aligned offset
 * (i.e. aligned to the minimum I/O unit size). Data starts next to the VID
 * header at the closest aligned offset. But this default layout may be
 * changed. For example, for different reasons (e.g., optimization) UBI may be
 * asked to put the VID header at further offset, and even at an unaligned
 * offset. Of course, if the offset of the VID header is unaligned, UBI adds
 * proper padding in front of it. Data offset may also be changed but it has to
 * be aligned.
 *
 * About minimal I/O units. In general, UBI assumes flash device model where
 * there is only one minimal I/O unit size. E.g., in case of NOR flash it is 1,
 * in case of NAND flash it is a NAND page, etc. This is reported by MTD in the
 * @ubi->mtd->writesize field. But as an exception, UBI admits use of another
 * (smaller) minimal I/O unit size for EC and VID headers to make it possible
 * to do different optimizations.
 *
 * This is extremely useful in case of NAND flashes which admit of several
 * write operations to one NAND page. In this case UBI can fit EC and VID
 * headers at one NAND page. Thus, UBI may use "sub-page" size as the minimal
 * I/O unit for the headers (the @ubi->hdrs_min_io_size field). But it still
 * reports NAND page size (@ubi->min_io_size) as a minimal I/O unit for the UBI
 * users.
 *
 * Example: some Samsung NANDs with 2KiB pages allow 4x 512-byte writes, so
 * although the minimal I/O unit is 2K, UBI uses 512 bytes for EC and VID
 * headers.
 *
 * Q: why not just to treat sub-page as a minimal I/O unit of this flash
 * device, e.g., make @ubi->min_io_size = 512 in the example above?
 *
 * A: because when writing a sub-page, MTD still writes a full 2K page but the
 * bytes which are not relevant to the sub-page are 0xFF. So, basically,
 * writing 4x512 sub-pages is 4 times slower than writing one 2KiB NAND page.
 * Thus, we prefer to use sub-pages only for EC and VID headers.
 *
 * As it was noted above, the VID header may start at a non-aligned offset.
 * For example, in case of a 2KiB page NAND flash with a 512 bytes sub-page,
 * the VID header may reside at offset 1984 which is the last 64 bytes of the
 * last sub-page (EC header is always at offset zero). This causes some
 * difficulties when reading and writing VID headers.
 *
 * Suppose we have a 64-byte buffer and we read a VID header at it. We change
 * the data and want to write this VID header out. As we can only write in
 * 512-byte chunks, we have to allocate one more buffer and copy our VID header
 * to offset 448 of this buffer.
 *
 * The I/O sub-system does the following trick in order to avoid this extra
 * copy. It always allocates a @ubi->vid_hdr_alsize bytes buffer for the VID
 * header and returns a pointer to offset @ubi->vid_hdr_shift of this buffer.
 * When the VID header is being written out, it shifts the VID header pointer
 * back and writes the whole sub-page.
 */

#include <linux/crc32.h>
#include <linux/err.h>
#include <linux/slab.h>
#include "ubi.h"

static int self_check_not_bad(const struct ubi_device *ubi, int pnum);
static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum);
static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
                             const struct ubi_ec_hdr *ec_hdr);
static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum);
static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
                              const struct ubi_vid_hdr *vid_hdr);
static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
                            int offset, int len);

/**
 * ubi_io_read - read data from a physical eraseblock.
 * @ubi: UBI device description object
 * @buf: buffer where to store the read data
 * @pnum: physical eraseblock number to read from
 * @offset: offset within the physical eraseblock from where to read
 * @len: how many bytes to read
 *
 * This function reads data from offset @offset of physical eraseblock @pnum
 * and stores the read data in the @buf buffer. The following return codes are
 * possible:
 *
 * o %0 if all the requested data were successfully read;
 * o %UBI_IO_BITFLIPS if all the requested data were successfully read, but
 *   correctable bit-flips were detected; this is harmless but may indicate
 *   that this eraseblock may become bad soon (but do not have to);
 * o %-EBADMSG if the MTD subsystem reported about data integrity problems, for
 *   example it can be an ECC error in case of NAND; this most probably means
 *   that the data is corrupted;
 * o %-EIO if some I/O error occurred;
 * o other negative error codes in case of other errors.
 */
int ubi_io_read(const struct ubi_device *ubi, void *buf, int pnum, int offset,
                int len)
{
        int err, retries = 0;
        size_t read;
        loff_t addr;

        dbg_io("read %d bytes from PEB %d:%d", len, pnum, offset);

        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
        ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
        ubi_assert(len > 0);

        err = self_check_not_bad(ubi, pnum);
        if (err)
                return err;

        /*
         * Deliberately corrupt the buffer to improve robustness. Indeed, if we
         * do not do this, the following may happen:
         * 1. The buffer contains data from previous operation, e.g., read from
         *    another PEB previously. The data looks like expected, e.g., if we
         *    just do not read anything and return - the caller would not
         *    notice this. E.g., if we are reading a VID header, the buffer may
         *    contain a valid VID header from another PEB.
         * 2. The driver is buggy and returns us success or -EBADMSG or
         *    -EUCLEAN, but it does not actually put any data to the buffer.
         *
         * This may confuse UBI or upper layers - they may think the buffer
         * contains valid data while in fact it is just old data. This is
         * especially possible because UBI (and UBIFS) relies on CRC, and
         * treats data as correct even in case of ECC errors if the CRC is
         * correct.
         *
         * Try to prevent this situation by changing the first byte of the
         * buffer.
         */
        *((uint8_t *)buf) ^= 0xFF;

        addr = (loff_t)pnum * ubi->peb_size + offset;
retry:
        err = mtd_read(ubi->mtd, addr, len, &read, buf);
        if (err) {
                const char *errstr = mtd_is_eccerr(err) ? " (ECC error)" : "";

                if (mtd_is_bitflip(err)) {
                        /*
                         * -EUCLEAN is reported if there was a bit-flip which
                         * was corrected, so this is harmless.
                         *
                         * We do not report about it here unless debugging is
                         * enabled. A corresponding message will be printed
                         * later, when it is has been scrubbed.
                         */
                        ubi_msg(ubi, "fixable bit-flip detected at PEB %d",
                                pnum);
                        ubi_assert(len == read);
                        return UBI_IO_BITFLIPS;
                }

                if (retries++ < UBI_IO_RETRIES) {
                        ubi_warn(ubi, "error %d%s while reading %d bytes from PEB %d:%d, read only %zd bytes, retry",
                                 err, errstr, len, pnum, offset, read);
                        yield();
                        goto retry;
                }

                ubi_err(ubi, "error %d%s while reading %d bytes from PEB %d:%d, read %zd bytes",
                        err, errstr, len, pnum, offset, read);
                dump_stack();

                /*
                 * The driver should never return -EBADMSG if it failed to read
                 * all the requested data. But some buggy drivers might do
                 * this, so we change it to -EIO.
                 */
                if (read != len && mtd_is_eccerr(err)) {
                        ubi_assert(0);
                        err = -EIO;
                }
        } else {
                ubi_assert(len == read);

                if (ubi_dbg_is_bitflip(ubi)) {
                        dbg_gen("bit-flip (emulated)");
                        return UBI_IO_BITFLIPS;
                }

                if (ubi_dbg_is_read_failure(ubi, MASK_READ_FAILURE)) {
                        ubi_warn(ubi, "cannot read %d bytes from PEB %d:%d (emulated)",
                                 len, pnum, offset);
                        return -EIO;
                }

                if (ubi_dbg_is_eccerr(ubi)) {
                        ubi_warn(ubi, "ECC error (emulated) while reading %d bytes from PEB %d:%d, read %zd bytes",
                                 len, pnum, offset, read);
                        return -EBADMSG;
                }
        }

        return err;
}

/**
 * ubi_io_write - write data to a physical eraseblock.
 * @ubi: UBI device description object
 * @buf: buffer with the data to write
 * @pnum: physical eraseblock number to write to
 * @offset: offset within the physical eraseblock where to write
 * @len: how many bytes to write
 *
 * This function writes @len bytes of data from buffer @buf to offset @offset
 * of physical eraseblock @pnum. If all the data were successfully written,
 * zero is returned. If an error occurred, this function returns a negative
 * error code. If %-EIO is returned, the physical eraseblock most probably went
 * bad.
 *
 * Note, in case of an error, it is possible that something was still written
 * to the flash media, but may be some garbage.
 */
int ubi_io_write(struct ubi_device *ubi, const void *buf, int pnum, int offset,
                 int len)
{
        int err;
        size_t written;
        loff_t addr;

        dbg_io("write %d bytes to PEB %d:%d", len, pnum, offset);

        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);
        ubi_assert(offset >= 0 && offset + len <= ubi->peb_size);
        ubi_assert(offset % ubi->hdrs_min_io_size == 0);
        ubi_assert(len > 0 && len % ubi->hdrs_min_io_size == 0);

        if (ubi->ro_mode) {
                ubi_err(ubi, "read-only mode");
                return -EROFS;
        }

        err = self_check_not_bad(ubi, pnum);
        if (err)
                return err;

        /* The area we are writing to has to contain all 0xFF bytes */
        err = ubi_self_check_all_ff(ubi, pnum, offset, len);
        if (err)
                return err;

        if (offset >= ubi->leb_start) {
                /*
                 * We write to the data area of the physical eraseblock. Make
                 * sure it has valid EC and VID headers.
                 */
                err = self_check_peb_ec_hdr(ubi, pnum);
                if (err)
                        return err;
                err = self_check_peb_vid_hdr(ubi, pnum);
                if (err)
                        return err;
        }

        if (ubi_dbg_is_write_failure(ubi)) {
                ubi_err(ubi, "cannot write %d bytes to PEB %d:%d (emulated)",
                        len, pnum, offset);
                dump_stack();
                return -EIO;
        }

        addr = (loff_t)pnum * ubi->peb_size + offset;
        err = mtd_write(ubi->mtd, addr, len, &written, buf);
        if (err) {
                ubi_err(ubi, "error %d while writing %d bytes to PEB %d:%d, written %zd bytes",
                        err, len, pnum, offset, written);
                dump_stack();
                ubi_dump_flash(ubi, pnum, offset, len);
        } else
                ubi_assert(written == len);

        if (!err) {
                err = self_check_write(ubi, buf, pnum, offset, len);
                if (err)
                        return err;

                /*
                 * Since we always write sequentially, the rest of the PEB has
                 * to contain only 0xFF bytes.
                 */
                offset += len;
                len = ubi->peb_size - offset;
                if (len)
                        err = ubi_self_check_all_ff(ubi, pnum, offset, len);
        }

        return err;
}

/**
 * do_sync_erase - synchronously erase a physical eraseblock.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to erase
 *
 * This function synchronously erases physical eraseblock @pnum and returns
 * zero in case of success and a negative error code in case of failure. If
 * %-EIO is returned, the physical eraseblock most probably went bad.
 */
static int do_sync_erase(struct ubi_device *ubi, int pnum)
{
        int err, retries = 0;
        struct erase_info ei;

        dbg_io("erase PEB %d", pnum);
        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);

        if (ubi->ro_mode) {
                ubi_err(ubi, "read-only mode");
                return -EROFS;
        }

retry:
        memset(&ei, 0, sizeof(struct erase_info));

        ei.addr     = (loff_t)pnum * ubi->peb_size;
        ei.len      = ubi->peb_size;

        err = mtd_erase(ubi->mtd, &ei);
        if (err) {
                if (retries++ < UBI_IO_RETRIES) {
                        ubi_warn(ubi, "error %d while erasing PEB %d, retry",
                                 err, pnum);
                        yield();
                        goto retry;
                }
                ubi_err(ubi, "cannot erase PEB %d, error %d", pnum, err);
                dump_stack();
                return err;
        }

        err = ubi_self_check_all_ff(ubi, pnum, 0, ubi->peb_size);
        if (err)
                return err;

        if (ubi_dbg_is_erase_failure(ubi)) {
                ubi_err(ubi, "cannot erase PEB %d (emulated)", pnum);
                return -EIO;
        }

        return 0;
}

/* Patterns to write to a physical eraseblock when torturing it */
static uint8_t patterns[] = {0xa5, 0x5a, 0x0};

/**
 * torture_peb - test a supposedly bad physical eraseblock.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to test
 *
 * This function returns %-EIO if the physical eraseblock did not pass the
 * test, a positive number of erase operations done if the test was
 * successfully passed, and other negative error codes in case of other errors.
 */
static int torture_peb(struct ubi_device *ubi, int pnum)
{
        int err, i, patt_count;

        ubi_msg(ubi, "run torture test for PEB %d", pnum);
        patt_count = ARRAY_SIZE(patterns);
        ubi_assert(patt_count > 0);

        mutex_lock(&ubi->buf_mutex);
        for (i = 0; i < patt_count; i++) {
                err = do_sync_erase(ubi, pnum);
                if (err)
                        goto out;

                /* Make sure the PEB contains only 0xFF bytes */
                err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
                if (err)
                        goto out;

                err = ubi_check_pattern(ubi->peb_buf, 0xFF, ubi->peb_size);
                if (err == 0) {
                        ubi_err(ubi, "erased PEB %d, but a non-0xFF byte found",
                                pnum);
                        err = -EIO;
                        goto out;
                }

                /* Write a pattern and check it */
                memset(ubi->peb_buf, patterns[i], ubi->peb_size);
                err = ubi_io_write(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
                if (err)
                        goto out;

                memset(ubi->peb_buf, ~patterns[i], ubi->peb_size);
                err = ubi_io_read(ubi, ubi->peb_buf, pnum, 0, ubi->peb_size);
                if (err)
                        goto out;

                err = ubi_check_pattern(ubi->peb_buf, patterns[i],
                                        ubi->peb_size);
                if (err == 0) {
                        ubi_err(ubi, "pattern %x checking failed for PEB %d",
                                patterns[i], pnum);
                        err = -EIO;
                        goto out;
                }
        }

        err = patt_count;
        ubi_msg(ubi, "PEB %d passed torture test, do not mark it as bad", pnum);

out:
        mutex_unlock(&ubi->buf_mutex);
        if (err == UBI_IO_BITFLIPS || mtd_is_eccerr(err)) {
                /*
                 * If a bit-flip or data integrity error was detected, the test
                 * has not passed because it happened on a freshly erased
                 * physical eraseblock which means something is wrong with it.
                 */
                ubi_err(ubi, "read problems on freshly erased PEB %d, must be bad",
                        pnum);
                err = -EIO;
        }
        return err;
}

/**
 * nor_erase_prepare - prepare a NOR flash PEB for erasure.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number to prepare
 *
 * NOR flash, or at least some of them, have peculiar embedded PEB erasure
 * algorithm: the PEB is first filled with zeroes, then it is erased. And
 * filling with zeroes starts from the end of the PEB. This was observed with
 * Spansion S29GL512N NOR flash.
 *
 * This means that in case of a power cut we may end up with intact data at the
 * beginning of the PEB, and all zeroes at the end of PEB. In other words, the
 * EC and VID headers are OK, but a large chunk of data at the end of PEB is
 * zeroed. This makes UBI mistakenly treat this PEB as used and associate it
 * with an LEB, which leads to subsequent failures (e.g., UBIFS fails).
 *
 * This function is called before erasing NOR PEBs and it zeroes out EC and VID
 * magic numbers in order to invalidate them and prevent the failures. Returns
 * zero in case of success and a negative error code in case of failure.
 */
static int nor_erase_prepare(struct ubi_device *ubi, int pnum)
{
        int err;
        size_t written;
        loff_t addr;
        uint32_t data = 0;
        struct ubi_ec_hdr ec_hdr;
        struct ubi_vid_io_buf vidb;

        /*
         * Note, we cannot generally define VID header buffers on stack,
         * because of the way we deal with these buffers (see the header
         * comment in this file). But we know this is a NOR-specific piece of
         * code, so we can do this. But yes, this is error-prone and we should
         * (pre-)allocate VID header buffer instead.
         */
        struct ubi_vid_hdr vid_hdr;

        /*
         * If VID or EC is valid, we have to corrupt them before erasing.
         * It is important to first invalidate the EC header, and then the VID
         * header. Otherwise a power cut may lead to valid EC header and
         * invalid VID header, in which case UBI will treat this PEB as
         * corrupted and will try to preserve it, and print scary warnings.
         */
        addr = (loff_t)pnum * ubi->peb_size;
        err = ubi_io_read_ec_hdr(ubi, pnum, &ec_hdr, 0);
        if (err != UBI_IO_BAD_HDR_EBADMSG && err != UBI_IO_BAD_HDR &&
            err != UBI_IO_FF){
                err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
                if(err)
                        goto error;
        }

        ubi_init_vid_buf(ubi, &vidb, &vid_hdr);
        ubi_assert(&vid_hdr == ubi_get_vid_hdr(&vidb));

        err = ubi_io_read_vid_hdr(ubi, pnum, &vidb, 0);
        if (err != UBI_IO_BAD_HDR_EBADMSG && err != UBI_IO_BAD_HDR &&
            err != UBI_IO_FF){
                addr += ubi->vid_hdr_aloffset;
                err = mtd_write(ubi->mtd, addr, 4, &written, (void *)&data);
                if (err)
                        goto error;
        }
        return 0;

error:
        /*
         * The PEB contains a valid VID or EC header, but we cannot invalidate
         * it. Supposedly the flash media or the driver is screwed up, so
         * return an error.
         */
        ubi_err(ubi, "cannot invalidate PEB %d, write returned %d", pnum, err);
        ubi_dump_flash(ubi, pnum, 0, ubi->peb_size);
        return -EIO;
}

/**
 * ubi_io_sync_erase - synchronously erase a physical eraseblock.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number to erase
 * @torture: if this physical eraseblock has to be tortured
 *
 * This function synchronously erases physical eraseblock @pnum. If @torture
 * flag is not zero, the physical eraseblock is checked by means of writing
 * different patterns to it and reading them back. If the torturing is enabled,
 * the physical eraseblock is erased more than once.
 *
 * This function returns the number of erasures made in case of success, %-EIO
 * if the erasure failed or the torturing test failed, and other negative error
 * codes in case of other errors. Note, %-EIO means that the physical
 * eraseblock is bad.
 */
int ubi_io_sync_erase(struct ubi_device *ubi, int pnum, int torture)
{
        int err, ret = 0;

        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);

        err = self_check_not_bad(ubi, pnum);
        if (err != 0)
                return err;

        if (ubi->ro_mode) {
                ubi_err(ubi, "read-only mode");
                return -EROFS;
        }

        /*
         * If the flash is ECC-ed then we have to erase the ECC block before we
         * can write to it. But the write is in preparation to an erase in the
         * first place. This means we cannot zero out EC and VID before the
         * erase and we just have to hope the flash starts erasing from the
         * start of the page.
         */
        if (ubi->nor_flash && ubi->mtd->writesize == 1) {
                err = nor_erase_prepare(ubi, pnum);
                if (err)
                        return err;
        }

        if (torture) {
                ret = torture_peb(ubi, pnum);
                if (ret < 0)
                        return ret;
        }

        err = do_sync_erase(ubi, pnum);
        if (err)
                return err;

        return ret + 1;
}

/**
 * ubi_io_is_bad - check if a physical eraseblock is bad.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to check
 *
 * This function returns a positive number if the physical eraseblock is bad,
 * zero if not, and a negative error code if an error occurred.
 */
int ubi_io_is_bad(const struct ubi_device *ubi, int pnum)
{
        struct mtd_info *mtd = ubi->mtd;

        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);

        if (ubi->bad_allowed) {
                int ret;

                ret = mtd_block_isbad(mtd, (loff_t)pnum * ubi->peb_size);
                if (ret < 0)
                        ubi_err(ubi, "error %d while checking if PEB %d is bad",
                                ret, pnum);
                else if (ret)
                        dbg_io("PEB %d is bad", pnum);
                return ret;
        }

        return 0;
}

/**
 * ubi_io_mark_bad - mark a physical eraseblock as bad.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to mark
 *
 * This function returns zero in case of success and a negative error code in
 * case of failure.
 */
int ubi_io_mark_bad(const struct ubi_device *ubi, int pnum)
{
        int err;
        struct mtd_info *mtd = ubi->mtd;

        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);

        if (ubi->ro_mode) {
                ubi_err(ubi, "read-only mode");
                return -EROFS;
        }

        if (!ubi->bad_allowed)
                return 0;

        err = mtd_block_markbad(mtd, (loff_t)pnum * ubi->peb_size);
        if (err)
                ubi_err(ubi, "cannot mark PEB %d bad, error %d", pnum, err);
        return err;
}

/**
 * validate_ec_hdr - validate an erase counter header.
 * @ubi: UBI device description object
 * @ec_hdr: the erase counter header to check
 *
 * This function returns zero if the erase counter header is OK, and %1 if
 * not.
 */
static int validate_ec_hdr(const struct ubi_device *ubi,
                           const struct ubi_ec_hdr *ec_hdr)
{
        long long ec;
        int vid_hdr_offset, leb_start;

        ec = be64_to_cpu(ec_hdr->ec);
        vid_hdr_offset = be32_to_cpu(ec_hdr->vid_hdr_offset);
        leb_start = be32_to_cpu(ec_hdr->data_offset);

        if (ec_hdr->version != UBI_VERSION) {
                ubi_err(ubi, "node with incompatible UBI version found: this UBI version is %d, image version is %d",
                        UBI_VERSION, (int)ec_hdr->version);
                goto bad;
        }

        if (vid_hdr_offset != ubi->vid_hdr_offset) {
                ubi_err(ubi, "bad VID header offset %d, expected %d",
                        vid_hdr_offset, ubi->vid_hdr_offset);
                goto bad;
        }

        if (leb_start != ubi->leb_start) {
                ubi_err(ubi, "bad data offset %d, expected %d",
                        leb_start, ubi->leb_start);
                goto bad;
        }

        if (ec < 0 || ec > UBI_MAX_ERASECOUNTER) {
                ubi_err(ubi, "bad erase counter %lld", ec);
                goto bad;
        }

        return 0;

bad:
        ubi_err(ubi, "bad EC header");
        ubi_dump_ec_hdr(ec_hdr);
        dump_stack();
        return 1;
}

/**
 * ubi_io_read_ec_hdr - read and check an erase counter header.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock to read from
 * @ec_hdr: a &struct ubi_ec_hdr object where to store the read erase counter
 * header
 * @verbose: be verbose if the header is corrupted or was not found
 *
 * This function reads erase counter header from physical eraseblock @pnum and
 * stores it in @ec_hdr. This function also checks CRC checksum of the read
 * erase counter header. The following codes may be returned:
 *
 * o %0 if the CRC checksum is correct and the header was successfully read;
 * o %UBI_IO_BITFLIPS if the CRC is correct, but bit-flips were detected
 *   and corrected by the flash driver; this is harmless but may indicate that
 *   this eraseblock may become bad soon (but may be not);
 * o %UBI_IO_BAD_HDR if the erase counter header is corrupted (a CRC error);
 * o %UBI_IO_BAD_HDR_EBADMSG is the same as %UBI_IO_BAD_HDR, but there also was
 *   a data integrity error (uncorrectable ECC error in case of NAND);
 * o %UBI_IO_FF if only 0xFF bytes were read (the PEB is supposedly empty)
 * o a negative error code in case of failure.
 */
int ubi_io_read_ec_hdr(struct ubi_device *ubi, int pnum,
                       struct ubi_ec_hdr *ec_hdr, int verbose)
{
        int err, read_err;
        uint32_t crc, magic, hdr_crc;

        dbg_io("read EC header from PEB %d", pnum);
        ubi_assert(pnum >= 0 && pnum < ubi->peb_count);

        read_err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
        if (read_err) {
                if (read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
                        return read_err;

                /*
                 * We read all the data, but either a correctable bit-flip
                 * occurred, or MTD reported a data integrity error
                 * (uncorrectable ECC error in case of NAND). The former is
                 * harmless, the later may mean that the read data is
                 * corrupted. But we have a CRC check-sum and we will detect
                 * this. If the EC header is still OK, we just report this as
                 * there was a bit-flip, to force scrubbing.
                 */
        }

        magic = be32_to_cpu(ec_hdr->magic);
        if (magic != UBI_EC_HDR_MAGIC) {
                if (mtd_is_eccerr(read_err))
                        return UBI_IO_BAD_HDR_EBADMSG;

                /*
                 * The magic field is wrong. Let's check if we have read all
                 * 0xFF. If yes, this physical eraseblock is assumed to be
                 * empty.
                 */
                if (ubi_check_pattern(ec_hdr, 0xFF, UBI_EC_HDR_SIZE)) {
                        /* The physical eraseblock is supposedly empty */
                        if (verbose)
                                ubi_warn(ubi, "no EC header found at PEB %d, only 0xFF bytes",
                                         pnum);
                        dbg_bld("no EC header found at PEB %d, only 0xFF bytes",
                                pnum);
                        if (!read_err)
                                return UBI_IO_FF;
                        else
                                return UBI_IO_FF_BITFLIPS;
                }

                /*
                 * This is not a valid erase counter header, and these are not
                 * 0xFF bytes. Report that the header is corrupted.
                 */
                if (verbose) {
                        ubi_warn(ubi, "bad magic number at PEB %d: %08x instead of %08x",
                                 pnum, magic, UBI_EC_HDR_MAGIC);
                        ubi_dump_ec_hdr(ec_hdr);
                }
                dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
                        pnum, magic, UBI_EC_HDR_MAGIC);
                return UBI_IO_BAD_HDR;
        }

        crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
        hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);

        if (hdr_crc != crc) {
                if (verbose) {
                        ubi_warn(ubi, "bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
                                 pnum, crc, hdr_crc);
                        ubi_dump_ec_hdr(ec_hdr);
                }
                dbg_bld("bad EC header CRC at PEB %d, calculated %#08x, read %#08x",
                        pnum, crc, hdr_crc);

                if (!read_err)
                        return UBI_IO_BAD_HDR;
                else
                        return UBI_IO_BAD_HDR_EBADMSG;
        }

        /* And of course validate what has just been read from the media */
        err = validate_ec_hdr(ubi, ec_hdr);
        if (err) {
                ubi_err(ubi, "validation failed for PEB %d", pnum);
                return -EINVAL;
        }

        /*
         * If there was %-EBADMSG, but the header CRC is still OK, report about
         * a bit-flip to force scrubbing on this PEB.
         */
        if (read_err)
                return UBI_IO_BITFLIPS;

        if (ubi_dbg_is_read_failure(ubi, MASK_READ_FAILURE_EC)) {
                ubi_warn(ubi, "cannot read EC header from PEB %d (emulated)",
                         pnum);
                return -EIO;
        }

        if (ubi_dbg_is_ff(ubi, MASK_IO_FF_EC)) {
                ubi_warn(ubi, "bit-all-ff (emulated)");
                return UBI_IO_FF;
        }

        if (ubi_dbg_is_ff_bitflips(ubi, MASK_IO_FF_BITFLIPS_EC)) {
                ubi_warn(ubi, "bit-all-ff with error reported by MTD driver (emulated)");
                return UBI_IO_FF_BITFLIPS;
        }

        if (ubi_dbg_is_bad_hdr(ubi, MASK_BAD_HDR_EC)) {
                ubi_warn(ubi, "bad_hdr (emulated)");
                return UBI_IO_BAD_HDR;
        }

        if (ubi_dbg_is_bad_hdr_ebadmsg(ubi, MASK_BAD_HDR_EBADMSG_EC)) {
                ubi_warn(ubi, "bad_hdr with ECC error (emulated)");
                return UBI_IO_BAD_HDR_EBADMSG;
        }

        return 0;
}

/**
 * ubi_io_write_ec_hdr - write an erase counter header.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock to write to
 * @ec_hdr: the erase counter header to write
 *
 * This function writes erase counter header described by @ec_hdr to physical
 * eraseblock @pnum. It also fills most fields of @ec_hdr before writing, so
 * the caller do not have to fill them. Callers must only fill the @ec_hdr->ec
 * field.
 *
 * This function returns zero in case of success and a negative error code in
 * case of failure. If %-EIO is returned, the physical eraseblock most probably
 * went bad.
 */
int ubi_io_write_ec_hdr(struct ubi_device *ubi, int pnum,
                        struct ubi_ec_hdr *ec_hdr)
{
        int err;
        uint32_t crc;

        dbg_io("write EC header to PEB %d", pnum);
        ubi_assert(pnum >= 0 &&  pnum < ubi->peb_count);

        ec_hdr->magic = cpu_to_be32(UBI_EC_HDR_MAGIC);
        ec_hdr->version = UBI_VERSION;
        ec_hdr->vid_hdr_offset = cpu_to_be32(ubi->vid_hdr_offset);
        ec_hdr->data_offset = cpu_to_be32(ubi->leb_start);
        ec_hdr->image_seq = cpu_to_be32(ubi->image_seq);
        crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
        ec_hdr->hdr_crc = cpu_to_be32(crc);

        err = self_check_ec_hdr(ubi, pnum, ec_hdr);
        if (err)
                return err;

        if (ubi_dbg_is_power_cut(ubi, MASK_POWER_CUT_EC)) {
                ubi_warn(ubi, "emulating a power cut when writing EC header");
                ubi_ro_mode(ubi);
                return -EROFS;
        }

        memset((char *)ec_hdr + UBI_EC_HDR_SIZE, 0xFF, ubi->ec_hdr_alsize - UBI_EC_HDR_SIZE);

        err = ubi_io_write(ubi, ec_hdr, pnum, 0, ubi->ec_hdr_alsize);
        return err;
}

/**
 * validate_vid_hdr - validate a volume identifier header.
 * @ubi: UBI device description object
 * @vid_hdr: the volume identifier header to check
 *
 * This function checks that data stored in the volume identifier header
 * @vid_hdr. Returns zero if the VID header is OK and %1 if not.
 */
static int validate_vid_hdr(const struct ubi_device *ubi,
                            const struct ubi_vid_hdr *vid_hdr)
{
        int vol_type = vid_hdr->vol_type;
        int copy_flag = vid_hdr->copy_flag;
        int vol_id = be32_to_cpu(vid_hdr->vol_id);
        int lnum = be32_to_cpu(vid_hdr->lnum);
        int compat = vid_hdr->compat;
        int data_size = be32_to_cpu(vid_hdr->data_size);
        int used_ebs = be32_to_cpu(vid_hdr->used_ebs);
        int data_pad = be32_to_cpu(vid_hdr->data_pad);
        int data_crc = be32_to_cpu(vid_hdr->data_crc);
        int usable_leb_size = ubi->leb_size - data_pad;

        if (copy_flag != 0 && copy_flag != 1) {
                ubi_err(ubi, "bad copy_flag");
                goto bad;
        }

        if (vol_id < 0 || lnum < 0 || data_size < 0 || used_ebs < 0 ||
            data_pad < 0) {
                ubi_err(ubi, "negative values");
                goto bad;
        }

        if (vol_id >= UBI_MAX_VOLUMES && vol_id < UBI_INTERNAL_VOL_START) {
                ubi_err(ubi, "bad vol_id");
                goto bad;
        }

        if (vol_id < UBI_INTERNAL_VOL_START && compat != 0) {
                ubi_err(ubi, "bad compat");
                goto bad;
        }

        if (vol_id >= UBI_INTERNAL_VOL_START && compat != UBI_COMPAT_DELETE &&
            compat != UBI_COMPAT_RO && compat != UBI_COMPAT_PRESERVE &&
            compat != UBI_COMPAT_REJECT) {
                ubi_err(ubi, "bad compat");
                goto bad;
        }

        if (vol_type != UBI_VID_DYNAMIC && vol_type != UBI_VID_STATIC) {
                ubi_err(ubi, "bad vol_type");
                goto bad;
        }

        if (data_pad >= ubi->leb_size / 2) {
                ubi_err(ubi, "bad data_pad");
                goto bad;
        }

        if (data_size > ubi->leb_size) {
                ubi_err(ubi, "bad data_size");
                goto bad;
        }

        if (vol_type == UBI_VID_STATIC) {
                /*
                 * Although from high-level point of view static volumes may
                 * contain zero bytes of data, but no VID headers can contain
                 * zero at these fields, because they empty volumes do not have
                 * mapped logical eraseblocks.
                 */
                if (used_ebs == 0) {
                        ubi_err(ubi, "zero used_ebs");
                        goto bad;
                }
                if (data_size == 0) {
                        ubi_err(ubi, "zero data_size");
                        goto bad;
                }
                if (lnum < used_ebs - 1) {
                        if (data_size != usable_leb_size) {
                                ubi_err(ubi, "bad data_size");
                                goto bad;
                        }
                } else if (lnum > used_ebs - 1) {
                        ubi_err(ubi, "too high lnum");
                        goto bad;
                }
        } else {
                if (copy_flag == 0) {
                        if (data_crc != 0) {
                                ubi_err(ubi, "non-zero data CRC");
                                goto bad;
                        }
                        if (data_size != 0) {
                                ubi_err(ubi, "non-zero data_size");
                                goto bad;
                        }
                } else {
                        if (data_size == 0) {
                                ubi_err(ubi, "zero data_size of copy");
                                goto bad;
                        }
                }
                if (used_ebs != 0) {
                        ubi_err(ubi, "bad used_ebs");
                        goto bad;
                }
        }

        return 0;

bad:
        ubi_err(ubi, "bad VID header");
        ubi_dump_vid_hdr(vid_hdr);
        dump_stack();
        return 1;
}

/**
 * ubi_io_read_vid_hdr - read and check a volume identifier header.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number to read from
 * @vidb: the volume identifier buffer to store data in
 * @verbose: be verbose if the header is corrupted or wasn't found
 *
 * This function reads the volume identifier header from physical eraseblock
 * @pnum and stores it in @vidb. It also checks CRC checksum of the read
 * volume identifier header. The error codes are the same as in
 * 'ubi_io_read_ec_hdr()'.
 *
 * Note, the implementation of this function is also very similar to
 * 'ubi_io_read_ec_hdr()', so refer commentaries in 'ubi_io_read_ec_hdr()'.
 */
int ubi_io_read_vid_hdr(struct ubi_device *ubi, int pnum,
                        struct ubi_vid_io_buf *vidb, int verbose)
{
        int err, read_err;
        uint32_t crc, magic, hdr_crc;
        struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
        void *p = vidb->buffer;

        dbg_io("read VID header from PEB %d", pnum);
        ubi_assert(pnum >= 0 &&  pnum < ubi->peb_count);

        read_err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
                          ubi->vid_hdr_shift + UBI_VID_HDR_SIZE);
        if (read_err && read_err != UBI_IO_BITFLIPS && !mtd_is_eccerr(read_err))
                return read_err;

        magic = be32_to_cpu(vid_hdr->magic);
        if (magic != UBI_VID_HDR_MAGIC) {
                if (mtd_is_eccerr(read_err))
                        return UBI_IO_BAD_HDR_EBADMSG;

                if (ubi_check_pattern(vid_hdr, 0xFF, UBI_VID_HDR_SIZE)) {
                        if (verbose)
                                ubi_warn(ubi, "no VID header found at PEB %d, only 0xFF bytes",
                                         pnum);
                        dbg_bld("no VID header found at PEB %d, only 0xFF bytes",
                                pnum);
                        if (!read_err)
                                return UBI_IO_FF;
                        else
                                return UBI_IO_FF_BITFLIPS;
                }

                if (verbose) {
                        ubi_warn(ubi, "bad magic number at PEB %d: %08x instead of %08x",
                                 pnum, magic, UBI_VID_HDR_MAGIC);
                        ubi_dump_vid_hdr(vid_hdr);
                }
                dbg_bld("bad magic number at PEB %d: %08x instead of %08x",
                        pnum, magic, UBI_VID_HDR_MAGIC);
                return UBI_IO_BAD_HDR;
        }

        crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
        hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);

        if (hdr_crc != crc) {
                if (verbose) {
                        ubi_warn(ubi, "bad CRC at PEB %d, calculated %#08x, read %#08x",
                                 pnum, crc, hdr_crc);
                        ubi_dump_vid_hdr(vid_hdr);
                }
                dbg_bld("bad CRC at PEB %d, calculated %#08x, read %#08x",
                        pnum, crc, hdr_crc);
                if (!read_err)
                        return UBI_IO_BAD_HDR;
                else
                        return UBI_IO_BAD_HDR_EBADMSG;
        }

        err = validate_vid_hdr(ubi, vid_hdr);
        if (err) {
                ubi_err(ubi, "validation failed for PEB %d", pnum);
                return -EINVAL;
        }

        if (read_err)
                return UBI_IO_BITFLIPS;

        if (ubi_dbg_is_read_failure(ubi, MASK_READ_FAILURE_VID)) {
                ubi_warn(ubi, "cannot read VID header from PEB %d (emulated)",
                         pnum);
                return -EIO;
        }

        if (ubi_dbg_is_ff(ubi, MASK_IO_FF_VID)) {
                ubi_warn(ubi, "bit-all-ff (emulated)");
                return UBI_IO_FF;
        }

        if (ubi_dbg_is_ff_bitflips(ubi, MASK_IO_FF_BITFLIPS_VID)) {
                ubi_warn(ubi, "bit-all-ff with error reported by MTD driver (emulated)");
                return UBI_IO_FF_BITFLIPS;
        }

        if (ubi_dbg_is_bad_hdr(ubi, MASK_BAD_HDR_VID)) {
                ubi_warn(ubi, "bad_hdr (emulated)");
                return UBI_IO_BAD_HDR;
        }

        if (ubi_dbg_is_bad_hdr_ebadmsg(ubi, MASK_BAD_HDR_EBADMSG_VID)) {
                ubi_warn(ubi, "bad_hdr with ECC error (emulated)");
                return UBI_IO_BAD_HDR_EBADMSG;
        }

        return 0;
}

/**
 * ubi_io_write_vid_hdr - write a volume identifier header.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to write to
 * @vidb: the volume identifier buffer to write
 *
 * This function writes the volume identifier header described by @vid_hdr to
 * physical eraseblock @pnum. This function automatically fills the
 * @vidb->hdr->magic and the @vidb->hdr->version fields, as well as calculates
 * header CRC checksum and stores it at vidb->hdr->hdr_crc.
 *
 * This function returns zero in case of success and a negative error code in
 * case of failure. If %-EIO is returned, the physical eraseblock probably went
 * bad.
 */
int ubi_io_write_vid_hdr(struct ubi_device *ubi, int pnum,
                         struct ubi_vid_io_buf *vidb)
{
        struct ubi_vid_hdr *vid_hdr = ubi_get_vid_hdr(vidb);
        int err;
        uint32_t crc;
        void *p = vidb->buffer;

        dbg_io("write VID header to PEB %d", pnum);
        ubi_assert(pnum >= 0 &&  pnum < ubi->peb_count);

        err = self_check_peb_ec_hdr(ubi, pnum);
        if (err)
                return err;

        vid_hdr->magic = cpu_to_be32(UBI_VID_HDR_MAGIC);
        vid_hdr->version = UBI_VERSION;
        crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
        vid_hdr->hdr_crc = cpu_to_be32(crc);

        err = self_check_vid_hdr(ubi, pnum, vid_hdr);
        if (err)
                return err;

        if (ubi_dbg_is_power_cut(ubi, MASK_POWER_CUT_VID)) {
                ubi_warn(ubi, "emulating a power cut when writing VID header");
                ubi_ro_mode(ubi);
                return -EROFS;
        }

        if (ubi->vid_hdr_shift) {
                memset((char *)p, 0xFF, ubi->vid_hdr_shift);
                memset((char *)p + ubi->vid_hdr_shift + UBI_VID_HDR_SIZE, 0xFF,
                       ubi->vid_hdr_alsize - (ubi->vid_hdr_shift + UBI_VID_HDR_SIZE));
        } else {
                memset((char *)p + UBI_VID_HDR_SIZE, 0xFF, ubi->vid_hdr_alsize - UBI_VID_HDR_SIZE);
        }

        err = ubi_io_write(ubi, p, pnum, ubi->vid_hdr_aloffset,
                           ubi->vid_hdr_alsize);
        return err;
}

/**
 * self_check_not_bad - ensure that a physical eraseblock is not bad.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number to check
 *
 * This function returns zero if the physical eraseblock is good, %-EINVAL if
 * it is bad and a negative error code if an error occurred.
 */
static int self_check_not_bad(const struct ubi_device *ubi, int pnum)
{
        int err;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        err = ubi_io_is_bad(ubi, pnum);
        if (!err)
                return err;

        ubi_err(ubi, "self-check failed for PEB %d", pnum);
        dump_stack();
        return err > 0 ? -EINVAL : err;
}

/**
 * self_check_ec_hdr - check if an erase counter header is all right.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number the erase counter header belongs to
 * @ec_hdr: the erase counter header to check
 *
 * This function returns zero if the erase counter header contains valid
 * values, and %-EINVAL if not.
 */
static int self_check_ec_hdr(const struct ubi_device *ubi, int pnum,
                             const struct ubi_ec_hdr *ec_hdr)
{
        int err;
        uint32_t magic;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        magic = be32_to_cpu(ec_hdr->magic);
        if (magic != UBI_EC_HDR_MAGIC) {
                ubi_err(ubi, "bad magic %#08x, must be %#08x",
                        magic, UBI_EC_HDR_MAGIC);
                goto fail;
        }

        err = validate_ec_hdr(ubi, ec_hdr);
        if (err) {
                ubi_err(ubi, "self-check failed for PEB %d", pnum);
                goto fail;
        }

        return 0;

fail:
        ubi_dump_ec_hdr(ec_hdr);
        dump_stack();
        return -EINVAL;
}

/**
 * self_check_peb_ec_hdr - check erase counter header.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to check
 *
 * This function returns zero if the erase counter header is all right and
 * a negative error code if not or if an error occurred.
 */
static int self_check_peb_ec_hdr(const struct ubi_device *ubi, int pnum)
{
        int err;
        uint32_t crc, hdr_crc;
        struct ubi_ec_hdr *ec_hdr;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        ec_hdr = kzalloc(ubi->ec_hdr_alsize, GFP_NOFS);
        if (!ec_hdr)
                return -ENOMEM;

        err = ubi_io_read(ubi, ec_hdr, pnum, 0, UBI_EC_HDR_SIZE);
        if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
                goto exit;

        crc = crc32(UBI_CRC32_INIT, ec_hdr, UBI_EC_HDR_SIZE_CRC);
        hdr_crc = be32_to_cpu(ec_hdr->hdr_crc);
        if (hdr_crc != crc) {
                ubi_err(ubi, "bad CRC, calculated %#08x, read %#08x",
                        crc, hdr_crc);
                ubi_err(ubi, "self-check failed for PEB %d", pnum);
                ubi_dump_ec_hdr(ec_hdr);
                dump_stack();
                err = -EINVAL;
                goto exit;
        }

        err = self_check_ec_hdr(ubi, pnum, ec_hdr);

exit:
        kfree(ec_hdr);
        return err;
}

/**
 * self_check_vid_hdr - check that a volume identifier header is all right.
 * @ubi: UBI device description object
 * @pnum: physical eraseblock number the volume identifier header belongs to
 * @vid_hdr: the volume identifier header to check
 *
 * This function returns zero if the volume identifier header is all right, and
 * %-EINVAL if not.
 */
static int self_check_vid_hdr(const struct ubi_device *ubi, int pnum,
                              const struct ubi_vid_hdr *vid_hdr)
{
        int err;
        uint32_t magic;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        magic = be32_to_cpu(vid_hdr->magic);
        if (magic != UBI_VID_HDR_MAGIC) {
                ubi_err(ubi, "bad VID header magic %#08x at PEB %d, must be %#08x",
                        magic, pnum, UBI_VID_HDR_MAGIC);
                goto fail;
        }

        err = validate_vid_hdr(ubi, vid_hdr);
        if (err) {
                ubi_err(ubi, "self-check failed for PEB %d", pnum);
                goto fail;
        }

        return err;

fail:
        ubi_err(ubi, "self-check failed for PEB %d", pnum);
        ubi_dump_vid_hdr(vid_hdr);
        dump_stack();
        return -EINVAL;

}

/**
 * self_check_peb_vid_hdr - check volume identifier header.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to check
 *
 * This function returns zero if the volume identifier header is all right,
 * and a negative error code if not or if an error occurred.
 */
static int self_check_peb_vid_hdr(const struct ubi_device *ubi, int pnum)
{
        int err;
        uint32_t crc, hdr_crc;
        struct ubi_vid_io_buf *vidb;
        struct ubi_vid_hdr *vid_hdr;
        void *p;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        vidb = ubi_alloc_vid_buf(ubi, GFP_NOFS);
        if (!vidb)
                return -ENOMEM;

        vid_hdr = ubi_get_vid_hdr(vidb);
        p = vidb->buffer;
        err = ubi_io_read(ubi, p, pnum, ubi->vid_hdr_aloffset,
                          ubi->vid_hdr_alsize);
        if (err && err != UBI_IO_BITFLIPS && !mtd_is_eccerr(err))
                goto exit;

        crc = crc32(UBI_CRC32_INIT, vid_hdr, UBI_VID_HDR_SIZE_CRC);
        hdr_crc = be32_to_cpu(vid_hdr->hdr_crc);
        if (hdr_crc != crc) {
                ubi_err(ubi, "bad VID header CRC at PEB %d, calculated %#08x, read %#08x",
                        pnum, crc, hdr_crc);
                ubi_err(ubi, "self-check failed for PEB %d", pnum);
                ubi_dump_vid_hdr(vid_hdr);
                dump_stack();
                err = -EINVAL;
                goto exit;
        }

        err = self_check_vid_hdr(ubi, pnum, vid_hdr);

exit:
        ubi_free_vid_buf(vidb);
        return err;
}

/**
 * self_check_write - make sure write succeeded.
 * @ubi: UBI device description object
 * @buf: buffer with data which were written
 * @pnum: physical eraseblock number the data were written to
 * @offset: offset within the physical eraseblock the data were written to
 * @len: how many bytes were written
 *
 * This functions reads data which were recently written and compares it with
 * the original data buffer - the data have to match. Returns zero if the data
 * match and a negative error code if not or in case of failure.
 */
static int self_check_write(struct ubi_device *ubi, const void *buf, int pnum,
                            int offset, int len)
{
        int err, i;
        size_t read;
        void *buf1;
        loff_t addr = (loff_t)pnum * ubi->peb_size + offset;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        buf1 = __vmalloc(len, GFP_NOFS);
        if (!buf1) {
                ubi_err(ubi, "cannot allocate memory to check writes");
                return 0;
        }

        err = mtd_read(ubi->mtd, addr, len, &read, buf1);
        if (err && !mtd_is_bitflip(err))
                goto out_free;

        for (i = 0; i < len; i++) {
                uint8_t c = ((uint8_t *)buf)[i];
                uint8_t c1 = ((uint8_t *)buf1)[i];
                int dump_len;

                if (c == c1)
                        continue;

                ubi_err(ubi, "self-check failed for PEB %d:%d, len %d",
                        pnum, offset, len);
                ubi_msg(ubi, "data differ at position %d", i);
                dump_len = max_t(int, 128, len - i);
                ubi_msg(ubi, "hex dump of the original buffer from %d to %d",
                        i, i + dump_len);
                print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
                               buf + i, dump_len, 1);
                ubi_msg(ubi, "hex dump of the read buffer from %d to %d",
                        i, i + dump_len);
                print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
                               buf1 + i, dump_len, 1);
                dump_stack();
                err = -EINVAL;
                goto out_free;
        }

        vfree(buf1);
        return 0;

out_free:
        vfree(buf1);
        return err;
}

/**
 * ubi_self_check_all_ff - check that a region of flash is empty.
 * @ubi: UBI device description object
 * @pnum: the physical eraseblock number to check
 * @offset: the starting offset within the physical eraseblock to check
 * @len: the length of the region to check
 *
 * This function returns zero if only 0xFF bytes are present at offset
 * @offset of the physical eraseblock @pnum, and a negative error code if not
 * or if an error occurred.
 */
int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len)
{
        size_t read;
        int err;
        void *buf;
        loff_t addr = (loff_t)pnum * ubi->peb_size + offset;

        if (!ubi_dbg_chk_io(ubi))
                return 0;

        buf = __vmalloc(len, GFP_NOFS);
        if (!buf) {
                ubi_err(ubi, "cannot allocate memory to check for 0xFFs");
                return 0;
        }

        err = mtd_read(ubi->mtd, addr, len, &read, buf);
        if (err && !mtd_is_bitflip(err)) {
                ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
                        err, len, pnum, offset, read);
                goto error;
        }

        err = ubi_check_pattern(buf, 0xFF, len);
        if (err == 0) {
                ubi_err(ubi, "flash region at PEB %d:%d, length %d does not contain all 0xFF bytes",
                        pnum, offset, len);
                goto fail;
        }

        vfree(buf);
        return 0;

fail:
        ubi_err(ubi, "self-check failed for PEB %d", pnum);
        ubi_msg(ubi, "hex dump of the %d-%d region", offset, offset + len);
        print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
        err = -EINVAL;
error:
        dump_stack();
        vfree(buf);
        return err;
}

























































































   33 

   29 
   48 



























   41 






   24 



   41 



   40 



























   41 


   41 
   41 















   19 





















    2 

    2 
    2 
    2 
    2 
    2 








    2 














    2 













    2 

    2 
    2 


    2 

    2 





    2 


    2 





















    2 







    2 
    2 


























    1 
























































   20 







   20 








    2 

   18 









   17 



   18 








   20 



   20 


   20 

























   22 

   20 


    1 

































   48 


   35 








   29 
   29 


   29 



    6 












    2 

   42 







   42 




   21 



   41 









   21 


   20 






   41 















  438 


   18 

   18 
   11 


   18 







   11 
   11 



   18 
  439 













   48 
   48 


   48 

    4 

   48 



   48 
   48 



   48 
   48 

   48 
   48 

   48 









    1 






   41 
   41 
   41 
   41 

   41 






   42 


   48 
























   53 



   52 

   22 

    9 

    9 



   13 








   13 





   13 

   13 




   13 





























  317 



  318 
   45 
    3 

   41 


   43 






   43 




   42 


   42 




















  407 


































  247 







    1 








    1 











    1 
  247 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
// SPDX-License-Identifier: GPL-2.0
/*
 * Key setup facility for FS encryption support.
 *
 * Copyright (C) 2015, Google, Inc.
 *
 * Originally written by Michael Halcrow, Ildar Muslukhov, and Uday Savagaonkar.
 * Heavily modified since then.
 */

#include <crypto/skcipher.h>
#include <linux/export.h>
#include <linux/random.h>

#include "fscrypt_private.h"

struct fscrypt_mode fscrypt_modes[] = {
        [FSCRYPT_MODE_AES_256_XTS] = {
                .friendly_name = "AES-256-XTS",
                .cipher_str = "xts(aes)",
                .keysize = 64,
                .security_strength = 32,
                .ivsize = 16,
                .blk_crypto_mode = BLK_ENCRYPTION_MODE_AES_256_XTS,
        },
        [FSCRYPT_MODE_AES_256_CTS] = {
                .friendly_name = "AES-256-CBC-CTS",
                .cipher_str = "cts(cbc(aes))",
                .keysize = 32,
                .security_strength = 32,
                .ivsize = 16,
        },
        [FSCRYPT_MODE_AES_128_CBC] = {
                .friendly_name = "AES-128-CBC-ESSIV",
                .cipher_str = "essiv(cbc(aes),sha256)",
                .keysize = 16,
                .security_strength = 16,
                .ivsize = 16,
                .blk_crypto_mode = BLK_ENCRYPTION_MODE_AES_128_CBC_ESSIV,
        },
        [FSCRYPT_MODE_AES_128_CTS] = {
                .friendly_name = "AES-128-CBC-CTS",
                .cipher_str = "cts(cbc(aes))",
                .keysize = 16,
                .security_strength = 16,
                .ivsize = 16,
        },
        [FSCRYPT_MODE_SM4_XTS] = {
                .friendly_name = "SM4-XTS",
                .cipher_str = "xts(sm4)",
                .keysize = 32,
                .security_strength = 16,
                .ivsize = 16,
                .blk_crypto_mode = BLK_ENCRYPTION_MODE_SM4_XTS,
        },
        [FSCRYPT_MODE_SM4_CTS] = {
                .friendly_name = "SM4-CBC-CTS",
                .cipher_str = "cts(cbc(sm4))",
                .keysize = 16,
                .security_strength = 16,
                .ivsize = 16,
        },
        [FSCRYPT_MODE_ADIANTUM] = {
                .friendly_name = "Adiantum",
                .cipher_str = "adiantum(xchacha12,aes)",
                .keysize = 32,
                .security_strength = 32,
                .ivsize = 32,
                .blk_crypto_mode = BLK_ENCRYPTION_MODE_ADIANTUM,
        },
        [FSCRYPT_MODE_AES_256_HCTR2] = {
                .friendly_name = "AES-256-HCTR2",
                .cipher_str = "hctr2(aes)",
                .keysize = 32,
                .security_strength = 32,
                .ivsize = 32,
        },
};

static DEFINE_MUTEX(fscrypt_mode_key_setup_mutex);

static struct fscrypt_mode *
select_encryption_mode(const union fscrypt_policy *policy,
                       const struct inode *inode)
{
        BUILD_BUG_ON(ARRAY_SIZE(fscrypt_modes) != FSCRYPT_MODE_MAX + 1);

        if (S_ISREG(inode->i_mode))
                return &fscrypt_modes[fscrypt_policy_contents_mode(policy)];

        if (S_ISDIR(inode->i_mode) || S_ISLNK(inode->i_mode))
                return &fscrypt_modes[fscrypt_policy_fnames_mode(policy)];

        WARN_ONCE(1, "fscrypt: filesystem tried to load encryption info for inode %llu, which is not encryptable (file type %d)\n",
                  inode->i_ino, (inode->i_mode & S_IFMT));
        return ERR_PTR(-EINVAL);
}

/* Create a symmetric cipher object for the given encryption mode and key */
static struct crypto_sync_skcipher *
fscrypt_allocate_skcipher(struct fscrypt_mode *mode, const u8 *raw_key,
                          const struct inode *inode)
{
        struct crypto_sync_skcipher *tfm;
        int err;

        tfm = crypto_alloc_sync_skcipher(mode->cipher_str, 0,
                                         FSCRYPT_CRYPTOAPI_MASK);
        if (IS_ERR(tfm)) {
                if (PTR_ERR(tfm) == -ENOENT) {
                        fscrypt_warn(inode,
                                     "Missing crypto API support for %s (API name: \"%s\")",
                                     mode->friendly_name, mode->cipher_str);
                        return ERR_PTR(-ENOPKG);
                }
                fscrypt_err(inode, "Error allocating '%s' transform: %ld",
                            mode->cipher_str, PTR_ERR(tfm));
                return tfm;
        }
        if (!xchg(&mode->logged_cryptoapi_impl, 1)) {
                /*
                 * fscrypt performance can vary greatly depending on which
                 * crypto algorithm implementation is used.  Help people debug
                 * performance problems by logging the ->cra_driver_name the
                 * first time a mode is used.
                 */
                pr_info("fscrypt: %s using implementation \"%s\"\n",
                        mode->friendly_name,
                        crypto_skcipher_driver_name(&tfm->base));
        }
        if (WARN_ON_ONCE(crypto_sync_skcipher_ivsize(tfm) != mode->ivsize)) {
                err = -EINVAL;
                goto err_free_tfm;
        }
        crypto_sync_skcipher_set_flags(tfm, CRYPTO_TFM_REQ_FORBID_WEAK_KEYS);
        err = crypto_sync_skcipher_setkey(tfm, raw_key, mode->keysize);
        if (err)
                goto err_free_tfm;

        return tfm;

err_free_tfm:
        crypto_free_sync_skcipher(tfm);
        return ERR_PTR(err);
}

/*
 * Prepare the crypto transform object or blk-crypto key in @prep_key, given the
 * raw key, encryption mode (@ci->ci_mode), flag indicating which encryption
 * implementation (fs-layer or blk-crypto) will be used (@ci->ci_inlinecrypt),
 * and IV generation method (@ci->ci_policy.flags).
 */
int fscrypt_prepare_key(struct fscrypt_prepared_key *prep_key,
                        const u8 *raw_key, const struct fscrypt_inode_info *ci)
{
        struct crypto_sync_skcipher *tfm;

        if (fscrypt_using_inline_encryption(ci))
                return fscrypt_prepare_inline_crypt_key(prep_key, raw_key,
                                                        ci->ci_mode->keysize,
                                                        false, ci);

        tfm = fscrypt_allocate_skcipher(ci->ci_mode, raw_key, ci->ci_inode);
        if (IS_ERR(tfm))
                return PTR_ERR(tfm);
        prep_key->tfm = tfm;
        return 0;
}

/* Destroy a crypto transform object and/or blk-crypto key. */
void fscrypt_destroy_prepared_key(struct super_block *sb,
                                  struct fscrypt_prepared_key *prep_key)
{
        crypto_free_sync_skcipher(prep_key->tfm);
        fscrypt_destroy_inline_crypt_key(sb, prep_key);
        memzero_explicit(prep_key, sizeof(*prep_key));
}

/* Given a per-file encryption key, set up the file's crypto transform object */
int fscrypt_set_per_file_enc_key(struct fscrypt_inode_info *ci,
                                 const u8 *raw_key)
{
        ci->ci_owns_key = true;
        return fscrypt_prepare_key(&ci->ci_enc_key, raw_key, ci);
}

/*
 * Find the fscrypt_prepared_key (if any) for a particular (mk, hkdf_context,
 * mode_num, data_unit_bits, inlinecrypt) combination.
 *
 * The caller must hold ->mk_sem for reading and ->mk_present must be true,
 * ensuring that ->mk_mode_keys is still append-only.
 */
static struct fscrypt_prepared_key *
fscrypt_find_mode_key(struct fscrypt_master_key *mk, u8 hkdf_context,
                      u8 mode_num, const struct fscrypt_inode_info *ci)
{
        struct fscrypt_mode_key *node;

        /*
         * The RCU read lock here is used only to synchronize with concurrent
         * list_add_tail_rcu().  Concurrent deletions are impossible here, so
         * returning a pointer to a node without taking any refcount is safe.
         */
        guard(rcu)();
        list_for_each_entry_rcu(node, &mk->mk_mode_keys, link) {
                if (node->hkdf_context == hkdf_context &&
                    node->mode_num == mode_num &&
                    node->data_unit_bits == ci->ci_data_unit_bits &&
                    fscrypt_is_key_prepared(&node->key, ci))
                        return &node->key;
        }
        return NULL;
}

static int setup_per_mode_enc_key(struct fscrypt_inode_info *ci,
                                  struct fscrypt_master_key *mk,
                                  u8 hkdf_context, bool include_fs_uuid)
{
        const struct inode *inode = ci->ci_inode;
        const struct super_block *sb = inode->i_sb;
        struct fscrypt_mode *mode = ci->ci_mode;
        const u8 mode_num = mode - fscrypt_modes;
        struct fscrypt_prepared_key *prep_key;
        struct fscrypt_mode_key *new_node;
        u8 raw_mode_key[FSCRYPT_MAX_RAW_KEY_SIZE];
        u8 hkdf_info[sizeof(mode_num) + sizeof(sb->s_uuid)];
        unsigned int hkdf_infolen = 0;
        bool use_hw_wrapped_key = false;
        int err;

        if (WARN_ON_ONCE(mode_num > FSCRYPT_MODE_MAX))
                return -EINVAL;

        if (mk->mk_secret.is_hw_wrapped && S_ISREG(inode->i_mode)) {
                /* Using a hardware-wrapped key for file contents encryption */
                if (!fscrypt_using_inline_encryption(ci)) {
                        if (sb->s_flags & SB_INLINECRYPT)
                                fscrypt_warn(ci->ci_inode,
                                             "Hardware-wrapped key required, but no suitable inline encryption capabilities are available");
                        else
                                fscrypt_warn(ci->ci_inode,
                                             "Hardware-wrapped keys require inline encryption (-o inlinecrypt)");
                        return -EINVAL;
                }
                use_hw_wrapped_key = true;
        }

        prep_key = fscrypt_find_mode_key(mk, hkdf_context, mode_num, ci);
        if (prep_key) {
                ci->ci_enc_key = *prep_key;
                return 0;
        }

        guard(mutex)(&fscrypt_mode_key_setup_mutex);

        prep_key = fscrypt_find_mode_key(mk, hkdf_context, mode_num, ci);
        if (prep_key) {
                ci->ci_enc_key = *prep_key;
                return 0;
        }

        new_node = kzalloc_obj(*new_node);
        if (!new_node)
                return -ENOMEM;
        new_node->hkdf_context = hkdf_context;
        new_node->mode_num = mode_num;
        new_node->data_unit_bits = ci->ci_data_unit_bits;
        prep_key = &new_node->key;

        if (use_hw_wrapped_key) {
                err = fscrypt_prepare_inline_crypt_key(prep_key,
                                                       mk->mk_secret.bytes,
                                                       mk->mk_secret.size, true,
                                                       ci);
        } else {
                static_assert(sizeof(mode_num) == 1);
                static_assert(sizeof(sb->s_uuid) == 16);
                static_assert(sizeof(hkdf_info) == 17);
                hkdf_info[hkdf_infolen++] = mode_num;
                if (include_fs_uuid) {
                        memcpy(&hkdf_info[hkdf_infolen], &sb->s_uuid,
                               sizeof(sb->s_uuid));
                        hkdf_infolen += sizeof(sb->s_uuid);
                }
                fscrypt_hkdf_expand(&mk->mk_secret.hkdf, hkdf_context,
                                    hkdf_info, hkdf_infolen, raw_mode_key,
                                    mode->keysize);
                err = fscrypt_prepare_key(prep_key, raw_mode_key, ci);
                memzero_explicit(raw_mode_key, mode->keysize);
        }
        if (err) {
                kfree(new_node);
                return err;
        }
        list_add_tail_rcu(&new_node->link, &mk->mk_mode_keys);
        ci->ci_enc_key = *prep_key;
        return 0;
}

/*
 * Derive a SipHash key from the given fscrypt master key and the given
 * application-specific information string.
 *
 * Note that the KDF produces a byte array, but the SipHash APIs expect the key
 * as a pair of 64-bit words.  Therefore, on big endian CPUs we have to do an
 * endianness swap in order to get the same results as on little endian CPUs.
 */
static void fscrypt_derive_siphash_key(const struct fscrypt_master_key *mk,
                                       u8 context, const u8 *info,
                                       unsigned int infolen, siphash_key_t *key)
{
        fscrypt_hkdf_expand(&mk->mk_secret.hkdf, context, info, infolen,
                            (u8 *)key, sizeof(*key));
        BUILD_BUG_ON(sizeof(*key) != 16);
        BUILD_BUG_ON(ARRAY_SIZE(key->key) != 2);
        le64_to_cpus(&key->key[0]);
        le64_to_cpus(&key->key[1]);
}

void fscrypt_derive_dirhash_key(struct fscrypt_inode_info *ci,
                                const struct fscrypt_master_key *mk)
{
        fscrypt_derive_siphash_key(mk, HKDF_CONTEXT_DIRHASH_KEY,
                                   ci->ci_nonce, FSCRYPT_FILE_NONCE_SIZE,
                                   &ci->ci_dirhash_key);
        ci->ci_dirhash_key_initialized = true;
}

void fscrypt_hash_inode_number(struct fscrypt_inode_info *ci,
                               const struct fscrypt_master_key *mk)
{
        WARN_ON_ONCE(ci->ci_inode->i_ino == 0);
        WARN_ON_ONCE(!mk->mk_ino_hash_key_initialized);

        ci->ci_hashed_ino = (u32)siphash_1u64(ci->ci_inode->i_ino,
                                              &mk->mk_ino_hash_key);
}

static int fscrypt_setup_iv_ino_lblk_32_key(struct fscrypt_inode_info *ci,
                                            struct fscrypt_master_key *mk)
{
        int err;

        err = setup_per_mode_enc_key(ci, mk, HKDF_CONTEXT_IV_INO_LBLK_32_KEY,
                                     true);
        if (err)
                return err;

        /* pairs with smp_store_release() below */
        if (!smp_load_acquire(&mk->mk_ino_hash_key_initialized)) {

                mutex_lock(&fscrypt_mode_key_setup_mutex);

                if (mk->mk_ino_hash_key_initialized)
                        goto unlock;

                fscrypt_derive_siphash_key(mk, HKDF_CONTEXT_INODE_HASH_KEY,
                                           NULL, 0, &mk->mk_ino_hash_key);
                /* pairs with smp_load_acquire() above */
                smp_store_release(&mk->mk_ino_hash_key_initialized, true);
unlock:
                mutex_unlock(&fscrypt_mode_key_setup_mutex);
        }

        /*
         * New inodes may not have an inode number assigned yet.
         * Hashing their inode number is delayed until later.
         */
        if (ci->ci_inode->i_ino)
                fscrypt_hash_inode_number(ci, mk);
        return 0;
}

static int fscrypt_setup_v2_file_key(struct fscrypt_inode_info *ci,
                                     struct fscrypt_master_key *mk,
                                     bool need_dirhash_key)
{
        int err;

        if (mk->mk_secret.is_hw_wrapped &&
            !(ci->ci_policy.v2.flags & (FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64 |
                                        FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32))) {
                fscrypt_warn(ci->ci_inode,
                             "Hardware-wrapped keys are only supported with IV_INO_LBLK policies");
                return -EINVAL;
        }

        if (ci->ci_policy.v2.flags & FSCRYPT_POLICY_FLAG_DIRECT_KEY) {
                /*
                 * DIRECT_KEY: instead of deriving per-file encryption keys, the
                 * per-file nonce will be included in all the IVs.  But unlike
                 * v1 policies, for v2 policies in this case we don't encrypt
                 * with the master key directly but rather derive a per-mode
                 * encryption key.  This ensures that the master key is
                 * consistently used only for HKDF, avoiding key reuse issues.
                 */
                err = setup_per_mode_enc_key(ci, mk, HKDF_CONTEXT_DIRECT_KEY,
                                             false);
        } else if (ci->ci_policy.v2.flags &
                   FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64) {
                /*
                 * IV_INO_LBLK_64: encryption keys are derived from (master_key,
                 * mode_num, filesystem_uuid), and inode number is included in
                 * the IVs.  This format is optimized for use with inline
                 * encryption hardware compliant with the UFS standard.
                 */
                err = setup_per_mode_enc_key(
                        ci, mk, HKDF_CONTEXT_IV_INO_LBLK_64_KEY, true);
        } else if (ci->ci_policy.v2.flags &
                   FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32) {
                err = fscrypt_setup_iv_ino_lblk_32_key(ci, mk);
        } else {
                u8 derived_key[FSCRYPT_MAX_RAW_KEY_SIZE];

                fscrypt_hkdf_expand(&mk->mk_secret.hkdf,
                                    HKDF_CONTEXT_PER_FILE_ENC_KEY,
                                    ci->ci_nonce, FSCRYPT_FILE_NONCE_SIZE,
                                    derived_key, ci->ci_mode->keysize);
                err = fscrypt_set_per_file_enc_key(ci, derived_key);
                memzero_explicit(derived_key, ci->ci_mode->keysize);
        }
        if (err)
                return err;

        /* Derive a secret dirhash key for directories that need it. */
        if (need_dirhash_key)
                fscrypt_derive_dirhash_key(ci, mk);

        return 0;
}

/*
 * Check whether the size of the given master key (@mk) is appropriate for the
 * encryption settings which a particular file will use (@ci).
 *
 * If the file uses a v1 encryption policy, then the master key must be at least
 * as long as the derived key, as this is a requirement of the v1 KDF.
 *
 * Otherwise, the KDF can accept any size key, so we enforce a slightly looser
 * requirement: we require that the size of the master key be at least the
 * maximum security strength of any algorithm whose key will be derived from it
 * (but in practice we only need to consider @ci->ci_mode, since any other
 * possible subkeys such as DIRHASH and INODE_HASH will never increase the
 * required key size over @ci->ci_mode).  This allows AES-256-XTS keys to be
 * derived from a 256-bit master key, which is cryptographically sufficient,
 * rather than requiring a 512-bit master key which is unnecessarily long.  (We
 * still allow 512-bit master keys if the user chooses to use them, though.)
 */
static bool fscrypt_valid_master_key_size(const struct fscrypt_master_key *mk,
                                          const struct fscrypt_inode_info *ci)
{
        unsigned int min_keysize;

        if (ci->ci_policy.version == FSCRYPT_POLICY_V1)
                min_keysize = ci->ci_mode->keysize;
        else
                min_keysize = ci->ci_mode->security_strength;

        if (mk->mk_secret.size < min_keysize) {
                fscrypt_warn(NULL,
                             "key with %s %*phN is too short (got %u bytes, need %u+ bytes)",
                             master_key_spec_type(&mk->mk_spec),
                             master_key_spec_len(&mk->mk_spec),
                             (u8 *)&mk->mk_spec.u,
                             mk->mk_secret.size, min_keysize);
                return false;
        }
        return true;
}

/*
 * Find the master key, then set up the inode's actual encryption key.
 *
 * If the master key is found in the filesystem-level keyring, then it is
 * returned in *mk_ret with its semaphore read-locked.  This is needed to ensure
 * that only one task links the fscrypt_inode_info into ->mk_decrypted_inodes
 * (as multiple tasks may race to create an fscrypt_inode_info for the same
 * inode), and to synchronize the master key being removed with a new inode
 * starting to use it.
 */
static int setup_file_encryption_key(struct fscrypt_inode_info *ci,
                                     bool need_dirhash_key,
                                     struct fscrypt_master_key **mk_ret)
{
        struct super_block *sb = ci->ci_inode->i_sb;
        struct fscrypt_key_specifier mk_spec;
        struct fscrypt_master_key *mk;
        int err;

        err = fscrypt_policy_to_key_spec(&ci->ci_policy, &mk_spec);
        if (err)
                return err;

        mk = fscrypt_find_master_key(sb, &mk_spec);
        if (unlikely(!mk)) {
                const union fscrypt_policy *dummy_policy =
                        fscrypt_get_dummy_policy(sb);

                /*
                 * Add the test_dummy_encryption key on-demand.  In principle,
                 * it should be added at mount time.  Do it here instead so that
                 * the individual filesystems don't need to worry about adding
                 * this key at mount time and cleaning up on mount failure.
                 */
                if (dummy_policy &&
                    fscrypt_policies_equal(dummy_policy, &ci->ci_policy)) {
                        err = fscrypt_add_test_dummy_key(sb, &mk_spec);
                        if (err)
                                return err;
                        mk = fscrypt_find_master_key(sb, &mk_spec);
                }
        }
        if (unlikely(!mk)) {
                if (ci->ci_policy.version != FSCRYPT_POLICY_V1)
                        return -ENOKEY;

                err = fscrypt_select_encryption_impl(ci, false);
                if (err)
                        return err;

                /*
                 * As a legacy fallback for v1 policies, search for the key in
                 * the current task's subscribed keyrings too.  Don't move this
                 * to before the search of ->s_master_keys, since users
                 * shouldn't be able to override filesystem-level keys.
                 */
                return fscrypt_setup_v1_file_key_via_subscribed_keyrings(ci);
        }
        down_read(&mk->mk_sem);

        if (!mk->mk_present) {
                /* FS_IOC_REMOVE_ENCRYPTION_KEY has been executed on this key */
                err = -ENOKEY;
                goto out_release_key;
        }

        if (!fscrypt_valid_master_key_size(mk, ci)) {
                err = -ENOKEY;
                goto out_release_key;
        }

        err = fscrypt_select_encryption_impl(ci, mk->mk_secret.is_hw_wrapped);
        if (err)
                goto out_release_key;

        switch (ci->ci_policy.version) {
        case FSCRYPT_POLICY_V1:
                if (WARN_ON_ONCE(mk->mk_secret.is_hw_wrapped)) {
                        /*
                         * This should never happen, as adding a v1 policy key
                         * that is hardware-wrapped isn't allowed.
                         */
                        err = -EINVAL;
                        goto out_release_key;
                }
                err = fscrypt_setup_v1_file_key(ci, mk->mk_secret.bytes);
                break;
        case FSCRYPT_POLICY_V2:
                err = fscrypt_setup_v2_file_key(ci, mk, need_dirhash_key);
                break;
        default:
                WARN_ON_ONCE(1);
                err = -EINVAL;
                break;
        }
        if (err)
                goto out_release_key;

        *mk_ret = mk;
        return 0;

out_release_key:
        up_read(&mk->mk_sem);
        fscrypt_put_master_key(mk);
        return err;
}

static void put_crypt_info(struct fscrypt_inode_info *ci)
{
        struct fscrypt_master_key *mk;

        if (!ci)
                return;

        if (ci->ci_direct_key)
                fscrypt_put_direct_key(ci->ci_direct_key);
        else if (ci->ci_owns_key)
                fscrypt_destroy_prepared_key(ci->ci_inode->i_sb,
                                             &ci->ci_enc_key);

        mk = ci->ci_master_key;
        if (mk) {
                /*
                 * Remove this inode from the list of inodes that were unlocked
                 * with the master key.  In addition, if we're removing the last
                 * inode from an incompletely removed key, then complete the
                 * full removal of the key.
                 */
                spin_lock(&mk->mk_decrypted_inodes_lock);
                list_del(&ci->ci_master_key_link);
                spin_unlock(&mk->mk_decrypted_inodes_lock);
                fscrypt_put_master_key_activeref(ci->ci_inode->i_sb, mk);
        }
        memzero_explicit(ci, sizeof(*ci));
        kmem_cache_free(fscrypt_inode_info_cachep, ci);
}

static int
fscrypt_setup_encryption_info(struct inode *inode,
                              const union fscrypt_policy *policy,
                              const u8 nonce[FSCRYPT_FILE_NONCE_SIZE],
                              bool need_dirhash_key)
{
        struct fscrypt_inode_info *crypt_info;
        struct fscrypt_mode *mode;
        struct fscrypt_master_key *mk = NULL;
        int res;

        res = fscrypt_initialize(inode->i_sb);
        if (res)
                return res;

        crypt_info = kmem_cache_zalloc(fscrypt_inode_info_cachep, GFP_KERNEL);
        if (!crypt_info)
                return -ENOMEM;

        crypt_info->ci_inode = inode;
        crypt_info->ci_policy = *policy;
        memcpy(crypt_info->ci_nonce, nonce, FSCRYPT_FILE_NONCE_SIZE);

        mode = select_encryption_mode(&crypt_info->ci_policy, inode);
        if (IS_ERR(mode)) {
                res = PTR_ERR(mode);
                goto out;
        }
        WARN_ON_ONCE(mode->ivsize > FSCRYPT_MAX_IV_SIZE);
        crypt_info->ci_mode = mode;

        crypt_info->ci_data_unit_bits =
                fscrypt_policy_du_bits(&crypt_info->ci_policy, inode);

        res = setup_file_encryption_key(crypt_info, need_dirhash_key, &mk);
        if (res)
                goto out;

        /*
         * For existing inodes, multiple tasks may race to set the inode's
         * fscrypt info pointer.  So use cmpxchg_release().  This pairs with the
         * smp_load_acquire() in fscrypt_get_inode_info().  I.e., publish the
         * pointer with a RELEASE barrier so that other tasks can ACQUIRE it.
         */
        if (cmpxchg_release(fscrypt_inode_info_addr(inode), NULL, crypt_info) ==
            NULL) {
                /*
                 * We won the race and set the inode's fscrypt info to our
                 * crypt_info.  Now link it into the master key's inode list.
                 */
                if (mk) {
                        crypt_info->ci_master_key = mk;
                        refcount_inc(&mk->mk_active_refs);
                        spin_lock(&mk->mk_decrypted_inodes_lock);
                        list_add(&crypt_info->ci_master_key_link,
                                 &mk->mk_decrypted_inodes);
                        spin_unlock(&mk->mk_decrypted_inodes_lock);
                }
                crypt_info = NULL;
        }
        res = 0;
out:
        if (mk) {
                up_read(&mk->mk_sem);
                fscrypt_put_master_key(mk);
        }
        put_crypt_info(crypt_info);
        return res;
}

/**
 * fscrypt_get_encryption_info() - set up an inode's encryption key
 * @inode: the inode to set up the key for.  Must be encrypted.
 * @allow_unsupported: if %true, treat an unsupported encryption policy (or
 *                       unrecognized encryption context) the same way as the key
 *                       being unavailable, instead of returning an error.  Use
 *                       %false unless the operation being performed is needed in
 *                       order for files (or directories) to be deleted.
 *
 * Set up the inode's encryption key, if it hasn't already been done.
 *
 * Note: unless the key setup was already done, this isn't %GFP_NOFS-safe.  So
 * generally this shouldn't be called from within a filesystem transaction.
 *
 * Return: 0 if the key is now set up, *or* if it couldn't be set up because the
 *           needed master key is absent.  (Use fscrypt_has_encryption_key() to
 *           distinguish these cases.)  Also can return another -errno code.
 */
int fscrypt_get_encryption_info(struct inode *inode, bool allow_unsupported)
{
        int res;
        union fscrypt_context ctx;
        union fscrypt_policy policy;

        if (fscrypt_has_encryption_key(inode))
                return 0;

        res = inode->i_sb->s_cop->get_context(inode, &ctx, sizeof(ctx));
        if (res < 0) {
                if (res == -ERANGE && allow_unsupported)
                        return 0;
                fscrypt_warn(inode, "Error %d getting encryption context", res);
                return res;
        }

        res = fscrypt_policy_from_context(&policy, &ctx, res);
        if (res) {
                if (allow_unsupported)
                        return 0;
                fscrypt_warn(inode,
                             "Unrecognized or corrupt encryption context");
                return res;
        }

        if (!fscrypt_supported_policy(&policy, inode)) {
                if (allow_unsupported)
                        return 0;
                return -EINVAL;
        }

        res = fscrypt_setup_encryption_info(inode, &policy,
                                            fscrypt_context_nonce(&ctx),
                                            IS_CASEFOLDED(inode) &&
                                            S_ISDIR(inode->i_mode));

        if (res == -ENOPKG && allow_unsupported) /* Algorithm unavailable? */
                res = 0;
        if (res == -ENOKEY)
                res = 0;
        return res;
}

/**
 * fscrypt_prepare_new_inode() - prepare to create a new inode in a directory
 * @dir: a possibly-encrypted directory
 * @inode: the new inode.  ->i_mode and ->i_blkbits must be set already.
 *           ->i_ino doesn't need to be set yet.
 * @encrypt_ret: (output) set to %true if the new inode will be encrypted
 *
 * If the directory is encrypted, set up its encryption key in preparation for
 * encrypting the name of the new file.  Also, if the new inode will be
 * encrypted, set up its encryption key too and set *encrypt_ret=true.
 *
 * This isn't %GFP_NOFS-safe, and therefore it should be called before starting
 * any filesystem transaction to create the inode.  For this reason, ->i_ino
 * isn't required to be set yet, as the filesystem may not have set it yet.
 *
 * This doesn't persist the new inode's encryption context.  That still needs to
 * be done later by calling fscrypt_set_context().
 *
 * Return: 0 on success, -ENOKEY if a key needs to be set up for @dir or @inode
 *           but the needed master key is absent, or another -errno code
 */
int fscrypt_prepare_new_inode(struct inode *dir, struct inode *inode,
                              bool *encrypt_ret)
{
        const union fscrypt_policy *policy;
        u8 nonce[FSCRYPT_FILE_NONCE_SIZE];

        policy = fscrypt_policy_to_inherit(dir);
        if (policy == NULL)
                return 0;
        if (IS_ERR(policy))
                return PTR_ERR(policy);

        if (WARN_ON_ONCE(inode->i_blkbits == 0))
                return -EINVAL;

        if (WARN_ON_ONCE(inode->i_mode == 0))
                return -EINVAL;

        /*
         * Only regular files, directories, and symlinks are encrypted.
         * Special files like device nodes and named pipes aren't.
         */
        if (!S_ISREG(inode->i_mode) &&
            !S_ISDIR(inode->i_mode) &&
            !S_ISLNK(inode->i_mode))
                return 0;

        *encrypt_ret = true;

        get_random_bytes(nonce, FSCRYPT_FILE_NONCE_SIZE);
        return fscrypt_setup_encryption_info(inode, policy, nonce,
                                             IS_CASEFOLDED(dir) &&
                                             S_ISDIR(inode->i_mode));
}
EXPORT_SYMBOL_GPL(fscrypt_prepare_new_inode);

/**
 * fscrypt_put_encryption_info() - free most of an inode's fscrypt data
 * @inode: an inode being evicted
 *
 * Free the inode's fscrypt_inode_info.  Filesystems must call this when the
 * inode is being evicted.  An RCU grace period need not have elapsed yet.
 */
void fscrypt_put_encryption_info(struct inode *inode)
{
        /*
         * Ideally we'd start with a lightweight IS_ENCRYPTED() check here
         * before proceeding to retrieve and check the pointer.  However, during
         * inode creation, the fscrypt_inode_info is set before S_ENCRYPTED.  If
         * an error occurs, it needs to be cleaned up regardless.
         */
        struct fscrypt_inode_info **ci_addr = fscrypt_inode_info_addr(inode);

        put_crypt_info(*ci_addr);
        *ci_addr = NULL;
}
EXPORT_SYMBOL(fscrypt_put_encryption_info);

/**
 * fscrypt_free_inode() - free an inode's fscrypt data requiring RCU delay
 * @inode: an inode being freed
 *
 * Free the inode's cached decrypted symlink target, if any.  Filesystems must
 * call this after an RCU grace period, just before they free the inode.
 */
void fscrypt_free_inode(struct inode *inode)
{
        if (IS_ENCRYPTED(inode) && S_ISLNK(inode->i_mode)) {
                kfree(inode->i_link);
                inode->i_link = NULL;
        }
}
EXPORT_SYMBOL(fscrypt_free_inode);

/**
 * fscrypt_drop_inode() - check whether the inode's master key has been removed
 * @inode: an inode being considered for eviction
 *
 * Filesystems supporting fscrypt must call this from their ->drop_inode()
 * method so that encrypted inodes are evicted as soon as they're no longer in
 * use and their master key has been removed.
 *
 * Return: 1 if fscrypt wants the inode to be evicted now, otherwise 0
 */
int fscrypt_drop_inode(struct inode *inode)
{
        const struct fscrypt_inode_info *ci = fscrypt_get_inode_info(inode);

        /*
         * If ci is NULL, then the inode doesn't have an encryption key set up
         * so it's irrelevant.  If ci_master_key is NULL, then the master key
         * was provided via the legacy mechanism of the process-subscribed
         * keyrings, so we don't know whether it's been removed or not.
         */
        if (!ci || !ci->ci_master_key)
                return 0;

        /*
         * With proper, non-racy use of FS_IOC_REMOVE_ENCRYPTION_KEY, all inodes
         * protected by the key were cleaned by sync_filesystem().  But if
         * userspace is still using the files, inodes can be dirtied between
         * then and now.  We mustn't lose any writes, so skip dirty inodes here.
         */
        if (inode_state_read(inode) & I_DIRTY_ALL)
                return 0;

        /*
         * We can't take ->mk_sem here, since this runs in atomic context.
         * Therefore, ->mk_present can change concurrently, and our result may
         * immediately become outdated.  But there's no correctness problem with
         * unnecessarily evicting.  Nor is there a correctness problem with not
         * evicting while iput() is racing with the key being removed, since
         * then the thread removing the key will either evict the inode itself
         * or will correctly detect that it wasn't evicted due to the race.
         */
        return !READ_ONCE(ci->ci_master_key->mk_present);
}
EXPORT_SYMBOL_GPL(fscrypt_drop_inode);























   14 





   14 

   14 

    3 



   14 


















  102 
  103 
   75 


  103 
















  102 
   99 
  103 


  102 

  102 








  104 




  106 



   45 






    4 



   45 

   45 




   45 

   45 



   44 

   45 
   44 

   45 




   57 










   57 






   58 





   58 
    1 





   57 



   56 



    4 



   58 

   58 



   58 
   57 
   57 

   58 




    3 








    1 



    3 



    3 




    3 







    2 



    3 

    3 





   10 










   10 

    9 
    1 
    1 



    9 
    9 





    9 

    9 

    9 



    9 




   10 














    1 








    5 




    4 




    1 



























1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
// SPDX-License-Identifier: GPL-2.0
/*
 * fs/proc_namespace.c - handling of /proc/<pid>/{mounts,mountinfo,mountstats}
 *
 * In fact, that's a piece of procfs; it's *almost* isolated from
 * the rest of fs/proc, but has rather close relationships with
 * fs/namespace.c, thus here instead of fs/proc
 *
 */
#include <linux/mnt_namespace.h>
#include <linux/nsproxy.h>
#include <linux/security.h>
#include <linux/fs_struct.h>
#include <linux/sched/task.h>

#include "proc/internal.h" /* only for get_proc_task() in ->open() */

#include "pnode.h"
#include "internal.h"

static __poll_t mounts_poll(struct file *file, poll_table *wait)
{
        struct seq_file *m = file->private_data;
        struct proc_mounts *p = m->private;
        struct mnt_namespace *ns = p->ns;
        __poll_t res = EPOLLIN | EPOLLRDNORM;
        int event;

        poll_wait(file, &p->ns->poll, wait);

        event = READ_ONCE(ns->event);
        if (m->poll_event != event) {
                m->poll_event = event;
                res |= EPOLLERR | EPOLLPRI;
        }

        return res;
}

struct proc_fs_opts {
        int flag;
        const char *str;
};

static int show_sb_opts(struct seq_file *m, struct super_block *sb)
{
        static const struct proc_fs_opts fs_opts[] = {
                { SB_SYNCHRONOUS, ",sync" },
                { SB_DIRSYNC, ",dirsync" },
                { SB_MANDLOCK, ",mand" },
                { SB_LAZYTIME, ",lazytime" },
                { 0, NULL }
        };
        const struct proc_fs_opts *fs_infop;

        for (fs_infop = fs_opts; fs_infop->flag; fs_infop++) {
                if (sb->s_flags & fs_infop->flag)
                        seq_puts(m, fs_infop->str);
        }

        return security_sb_show_options(m, sb);
}

static void show_vfsmnt_opts(struct seq_file *m, struct vfsmount *mnt)
{
        static const struct proc_fs_opts mnt_opts[] = {
                { MNT_NOSUID, ",nosuid" },
                { MNT_NODEV, ",nodev" },
                { MNT_NOEXEC, ",noexec" },
                { MNT_NOATIME, ",noatime" },
                { MNT_NODIRATIME, ",nodiratime" },
                { MNT_RELATIME, ",relatime" },
                { MNT_NOSYMFOLLOW, ",nosymfollow" },
                { 0, NULL }
        };
        const struct proc_fs_opts *fs_infop;

        for (fs_infop = mnt_opts; fs_infop->flag; fs_infop++) {
                if (mnt->mnt_flags & fs_infop->flag)
                        seq_puts(m, fs_infop->str);
        }

        if (is_idmapped_mnt(mnt))
                seq_puts(m, ",idmapped");
}

static inline void mangle(struct seq_file *m, const char *s)
{
        seq_escape(m, s, " \t\n\\#");
}

static void show_type(struct seq_file *m, struct super_block *sb)
{
        mangle(m, sb->s_type->name);
        if (sb->s_subtype) {
                seq_putc(m, '.');
                mangle(m, sb->s_subtype);
        }
}

static int show_vfsmnt(struct seq_file *m, struct vfsmount *mnt)
{
        struct proc_mounts *p = m->private;
        struct mount *r = real_mount(mnt);
        struct path mnt_path = { .dentry = mnt->mnt_root, .mnt = mnt };
        struct super_block *sb = mnt_path.dentry->d_sb;
        int err;

        if (sb->s_op->show_devname) {
                err = sb->s_op->show_devname(m, mnt_path.dentry);
                if (err)
                        goto out;
        } else {
                mangle(m, r->mnt_devname);
        }
        seq_putc(m, ' ');
        /* mountpoints outside of chroot jail will give SEQ_SKIP on this */
        err = seq_path_root(m, &mnt_path, &p->root, " \t\n\\");
        if (err)
                goto out;
        seq_putc(m, ' ');
        show_type(m, sb);
        seq_puts(m, __mnt_is_readonly(mnt) ? " ro" : " rw");
        err = show_sb_opts(m, sb);
        if (err)
                goto out;
        show_vfsmnt_opts(m, mnt);
        if (sb->s_op->show_options)
                err = sb->s_op->show_options(m, mnt_path.dentry);
        seq_puts(m, " 0 0\n");
out:
        return err;
}

static int show_mountinfo(struct seq_file *m, struct vfsmount *mnt)
{
        struct proc_mounts *p = m->private;
        struct mount *r = real_mount(mnt);
        struct super_block *sb = mnt->mnt_sb;
        struct path mnt_path = { .dentry = mnt->mnt_root, .mnt = mnt };
        int err;

        seq_printf(m, "%i %i %u:%u ", r->mnt_id, r->mnt_parent->mnt_id,
                   MAJOR(sb->s_dev), MINOR(sb->s_dev));
        err = show_path(m, mnt->mnt_root);
        if (err)
                goto out;
        seq_putc(m, ' ');

        /* mountpoints outside of chroot jail will give SEQ_SKIP on this */
        err = seq_path_root(m, &mnt_path, &p->root, " \t\n\\");
        if (err)
                goto out;

        seq_puts(m, mnt->mnt_flags & MNT_READONLY ? " ro" : " rw");
        show_vfsmnt_opts(m, mnt);

        /* Tagged fields ("foo:X" or "bar") */
        if (IS_MNT_SHARED(r))
                seq_printf(m, " shared:%i", r->mnt_group_id);
        if (IS_MNT_SLAVE(r)) {
                int master = r->mnt_master->mnt_group_id;
                int dom = get_dominating_id(r, &p->root);
                seq_printf(m, " master:%i", master);
                if (dom && dom != master)
                        seq_printf(m, " propagate_from:%i", dom);
        }
        if (IS_MNT_UNBINDABLE(r))
                seq_puts(m, " unbindable");

        /* Filesystem specific data */
        seq_puts(m, " - ");
        show_type(m, sb);
        seq_putc(m, ' ');
        if (sb->s_op->show_devname) {
                err = sb->s_op->show_devname(m, mnt->mnt_root);
                if (err)
                        goto out;
        } else {
                mangle(m, r->mnt_devname);
        }
        seq_puts(m, sb_rdonly(sb) ? " ro" : " rw");
        err = show_sb_opts(m, sb);
        if (err)
                goto out;
        if (sb->s_op->show_options)
                err = sb->s_op->show_options(m, mnt->mnt_root);
        seq_putc(m, '\n');
out:
        return err;
}

static int show_vfsstat(struct seq_file *m, struct vfsmount *mnt)
{
        struct proc_mounts *p = m->private;
        struct mount *r = real_mount(mnt);
        struct path mnt_path = { .dentry = mnt->mnt_root, .mnt = mnt };
        struct super_block *sb = mnt_path.dentry->d_sb;
        int err;

        /* device */
        seq_puts(m, "device ");
        if (sb->s_op->show_devname) {
                err = sb->s_op->show_devname(m, mnt_path.dentry);
                if (err)
                        goto out;
        } else {
                mangle(m, r->mnt_devname);
        }

        /* mount point */
        seq_puts(m, " mounted on ");
        /* mountpoints outside of chroot jail will give SEQ_SKIP on this */
        err = seq_path_root(m, &mnt_path, &p->root, " \t\n\\");
        if (err)
                goto out;
        seq_putc(m, ' ');

        /* file system type */
        seq_puts(m, "with fstype ");
        show_type(m, sb);

        /* optional statistics */
        if (sb->s_op->show_stats) {
                seq_putc(m, ' ');
                err = sb->s_op->show_stats(m, mnt_path.dentry);
        }

        seq_putc(m, '\n');
out:
        return err;
}

static int mounts_open_common(struct inode *inode, struct file *file,
                              int (*show)(struct seq_file *, struct vfsmount *))
{
        struct task_struct *task = get_proc_task(inode);
        struct nsproxy *nsp;
        struct mnt_namespace *ns = NULL;
        struct path root;
        struct proc_mounts *p;
        struct seq_file *m;
        int ret = -EINVAL;

        if (!task)
                goto err;

        task_lock(task);
        nsp = task->nsproxy;
        if (!nsp || !nsp->mnt_ns) {
                task_unlock(task);
                put_task_struct(task);
                goto err;
        }
        ns = nsp->mnt_ns;
        get_mnt_ns(ns);
        if (!task->fs) {
                task_unlock(task);
                put_task_struct(task);
                ret = -ENOENT;
                goto err_put_ns;
        }
        get_fs_root(task->fs, &root);
        task_unlock(task);
        put_task_struct(task);

        ret = seq_open_private(file, &mounts_op, sizeof(struct proc_mounts));
        if (ret)
                goto err_put_path;

        m = file->private_data;
        m->poll_event = ns->event;

        p = m->private;
        p->ns = ns;
        p->root = root;
        p->show = show;

        return 0;

 err_put_path:
        path_put(&root);
 err_put_ns:
        put_mnt_ns(ns);
 err:
        return ret;
}

static int mounts_release(struct inode *inode, struct file *file)
{
        struct seq_file *m = file->private_data;
        struct proc_mounts *p = m->private;
        path_put(&p->root);
        put_mnt_ns(p->ns);
        return seq_release_private(inode, file);
}

static int mounts_open(struct inode *inode, struct file *file)
{
        return mounts_open_common(inode, file, show_vfsmnt);
}

static int mountinfo_open(struct inode *inode, struct file *file)
{
        return mounts_open_common(inode, file, show_mountinfo);
}

static int mountstats_open(struct inode *inode, struct file *file)
{
        return mounts_open_common(inode, file, show_vfsstat);
}

const struct file_operations proc_mounts_operations = {
        .open                = mounts_open,
        .read_iter        = seq_read_iter,
        .splice_read        = copy_splice_read,
        .llseek                = seq_lseek,
        .release        = mounts_release,
        .poll                = mounts_poll,
};

const struct file_operations proc_mountinfo_operations = {
        .open                = mountinfo_open,
        .read_iter        = seq_read_iter,
        .splice_read        = copy_splice_read,
        .llseek                = seq_lseek,
        .release        = mounts_release,
        .poll                = mounts_poll,
};

const struct file_operations proc_mountstats_operations = {
        .open                = mountstats_open,
        .read_iter        = seq_read_iter,
        .splice_read        = copy_splice_read,
        .llseek                = seq_lseek,
        .release        = mounts_release,
};




















































































































 2614 











  123 

 1681 




























  170 


   16 



































   55 




















 1393 





  925 


   62 




1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_SCHED_TASK_H
#define _LINUX_SCHED_TASK_H

/*
 * Interface between the scheduler and various task lifetime (fork()/exit())
 * functionality:
 */

#include <linux/rcupdate.h>
#include <linux/refcount.h>
#include <linux/sched.h>
#include <linux/uaccess.h>

struct task_struct;
struct rusage;
union thread_union;
struct css_set;

/* All the bits taken by the old clone syscall. */
#define CLONE_LEGACY_FLAGS 0xffffffffULL

struct kernel_clone_args {
        u64 flags;
        int __user *pidfd;
        int __user *child_tid;
        int __user *parent_tid;
        const char *name;
        int exit_signal;
        u32 kthread:1;
        u32 io_thread:1;
        u32 user_worker:1;
        u32 no_files:1;
        unsigned long stack;
        unsigned long stack_size;
        unsigned long tls;
        pid_t *set_tid;
        /* Number of elements in *set_tid */
        size_t set_tid_size;
        int cgroup;
        int idle;
        int (*fn)(void *);
        void *fn_arg;
        struct cgroup *cgrp;
        struct css_set *cset;
        unsigned int kill_seq;
};

/*
 * This serializes "schedule()" and also protects
 * the run-queue from deletions/modifications (but
 * _adding_ to the beginning of the run-queue has
 * a separate lock).
 */
extern rwlock_t tasklist_lock;
extern spinlock_t mmlist_lock;

extern union thread_union init_thread_union;
extern struct task_struct init_task;

extern int lockdep_tasklist_lock_is_held(void);

extern asmlinkage void schedule_tail(struct task_struct *prev);
extern void init_idle(struct task_struct *idle, int cpu);

extern int sched_fork(u64 clone_flags, struct task_struct *p);
extern int sched_cgroup_fork(struct task_struct *p, struct kernel_clone_args *kargs);
extern void sched_cancel_fork(struct task_struct *p);
extern void sched_post_fork(struct task_struct *p);
extern void sched_dead(struct task_struct *p);

void __noreturn do_task_dead(void);
void __noreturn make_task_dead(int signr);

extern void mm_cache_init(void);
extern void proc_caches_init(void);

extern void fork_init(void);

extern void release_task(struct task_struct * p);

extern int copy_thread(struct task_struct *, const struct kernel_clone_args *);

extern void flush_thread(void);

#ifdef CONFIG_HAVE_EXIT_THREAD
extern void exit_thread(struct task_struct *tsk);
#else
static inline void exit_thread(struct task_struct *tsk)
{
}
#endif
extern __noreturn void do_group_exit(int);

extern void exit_files(struct task_struct *);
extern void exit_itimers(struct task_struct *);

extern pid_t kernel_clone(struct kernel_clone_args *kargs);
struct task_struct *copy_process(struct pid *pid, int trace, int node,
                                 struct kernel_clone_args *args);
struct task_struct *create_io_thread(int (*fn)(void *), void *arg, int node);
struct task_struct *fork_idle(int);
extern pid_t kernel_thread(int (*fn)(void *), void *arg, const char *name,
                            unsigned long flags);
extern pid_t user_mode_thread(int (*fn)(void *), void *arg, unsigned long flags);
extern long kernel_wait4(pid_t, int __user *, int, struct rusage *);
int kernel_wait(pid_t pid, int *stat);

extern void free_task(struct task_struct *tsk);

/* sched_exec is called by processes performing an exec */
extern void sched_exec(void);

static inline struct task_struct *get_task_struct(struct task_struct *t)
{
        refcount_inc(&t->usage);
        return t;
}

static inline struct task_struct *tryget_task_struct(struct task_struct *t)
{
        return refcount_inc_not_zero(&t->usage) ? t : NULL;
}

extern void __put_task_struct(struct task_struct *t);
extern void __put_task_struct_rcu_cb(struct rcu_head *rhp);

static inline void put_task_struct(struct task_struct *t)
{
        if (!refcount_dec_and_test(&t->usage))
                return;

        /*
         * Under PREEMPT_RT, we can't call __put_task_struct
         * in atomic context because it will indirectly
         * acquire sleeping locks. The same is true if the
         * current process has a mutex enqueued (blocked on
         * a PI chain).
         *
         * In !RT, it is always safe to call __put_task_struct().
         * Though, in order to simplify the code, resort to the
         * deferred call too.
         *
         * call_rcu() will schedule __put_task_struct_rcu_cb()
         * to be called in process context.
         *
         * __put_task_struct() is called when
         * refcount_dec_and_test(&t->usage) succeeds.
         *
         * This means that it can't "conflict" with
         * put_task_struct_rcu_user() which abuses ->rcu the same
         * way; rcu_users has a reference so task->usage can't be
         * zero after rcu_users 1 -> 0 transition.
         *
         * delayed_free_task() also uses ->rcu, but it is only called
         * when it fails to fork a process. Therefore, there is no
         * way it can conflict with __put_task_struct().
         */
        call_rcu(&t->rcu, __put_task_struct_rcu_cb);
}

DEFINE_FREE(put_task, struct task_struct *, if (_T) put_task_struct(_T))

static inline void put_task_struct_many(struct task_struct *t, int nr)
{
        if (refcount_sub_and_test(nr, &t->usage))
                __put_task_struct(t);
}

void put_task_struct_rcu_user(struct task_struct *task);

/* Free all architecture-specific resources held by a thread. */
void release_thread(struct task_struct *dead_task);

#ifdef CONFIG_ARCH_WANTS_DYNAMIC_TASK_STRUCT
extern int arch_task_struct_size __read_mostly;
#else
# define arch_task_struct_size (sizeof(struct task_struct))
#endif

#ifndef CONFIG_HAVE_ARCH_THREAD_STRUCT_WHITELIST
/*
 * If an architecture has not declared a thread_struct whitelist we
 * must assume something there may need to be copied to userspace.
 */
static inline void arch_thread_struct_whitelist(unsigned long *offset,
                                                unsigned long *size)
{
        *offset = 0;
        /* Handle dynamically sized thread_struct. */
        *size = arch_task_struct_size - offsetof(struct task_struct, thread);
}
#endif

#ifdef CONFIG_VMAP_STACK
static inline struct vm_struct *task_stack_vm_area(const struct task_struct *t)
{
        return t->stack_vm_area;
}
#else
static inline struct vm_struct *task_stack_vm_area(const struct task_struct *t)
{
        return NULL;
}
#endif

/*
 * Protects ->fs, ->files, ->mm, ->group_info, ->comm, keyring
 * subscriptions and synchronises with wait4().  Also used in procfs.  Also
 * pins the final release of task.io_context.  Also protects ->cpuset and
 * ->cgroup.subsys[]. And ->vfork_done. And ->sysvshm.shm_clist.
 *
 * Nests inside of read_lock(&tasklist_lock). It must not be nested with
 * write_lock_irq(&tasklist_lock), neither inside nor outside.
 */
static inline void task_lock(struct task_struct *p)
        __acquires(&p->alloc_lock)
{
        spin_lock(&p->alloc_lock);
}

static inline void task_unlock(struct task_struct *p)
        __releases(&p->alloc_lock)
{
        spin_unlock(&p->alloc_lock);
}

DEFINE_LOCK_GUARD_1(task_lock, struct task_struct, task_lock(_T->lock), task_unlock(_T->lock))
DECLARE_LOCK_GUARD_1_ATTRS(task_lock, __acquires(&_T->alloc_lock), __releases(&(*(struct task_struct **)_T)->alloc_lock))
#define class_task_lock_constructor(_T) WITH_LOCK_GUARD_1_ATTRS(task_lock, _T)

#endif /* _LINUX_SCHED_TASK_H */





























    5 


    5 











    5 
    5 
















    5 




    5 




    2 




   71 

   65 


    2 


   70 

















    5 
    5 

    5 


    5 

    5 
















    5 
    5 

    5 

    5 

    5 



    2 






    5 
    5 

    5 





    5 
    5 




    5 
    5 





    5 


    5 








































































    5 



    5 








    5 
    5 


    5 








    5 


    5 






    5 

    5 


    5 
    5 






































































































































































































































































  194 

   13 

































    5 


    5 






    5 

    5 

    5 












    5 









    5 










    5 
    5 




    5 









    5 
    5 

    5 





    5 





    5 



    5 






    5 



    5 















    5 
    5 


    5 
    5 

    5 






    1 

    1 

    1 
    1 
    1 

    1 
    1 

    1 
    1 

    1 




































































































    5 

    5 




    5 




    5 


    5 

    5 

    5 
    5 




    5 
    5 





    5 
    5 

    5 


    5 
    5 



    5 








    5 



    5 
    5 




    5 








    2 






    7 
    7 







    2 
    2 







    2 
    2 




    2 





    2 



































    6 










    6 




    6 
    2 

    2 

    6 



    6 
    6 





















    6 














    5 

    5 

    5 

    5 

    5 






    5 
    5 
    5 
































    1 
    1 
    1 
    1 















    5 



    1 




    1 
    1 






    1 
    1 




    1 
















    1 
    1 

    1 





    1 


    1 










    1 
    1 














    5 









    5 






    1 









    1 

    1 
    1 

    1 






























































    5 


    5 































    5 






    5 



    5 





    5 
    5 
    5 



    5 
    5 

    5 



    5 

    5 



    5 






    5 

    5 

    5 


    5 














    5 

    5 
    5 

    5 


    5 





    5 
    1 
    5 
    1 
    5 



    5 
    1 

    5 
    5 






    5 

    5 


    5 

    5 










    5 

    5 
    5 


    5 
    1 
    5 




    5 



    5 



    5 
    5 


    5 
    5 
    5 





























    5 











































    5 







    5 
    5 


    5 



    5 



    5 


    5 


    5 

    5 

    5 

    5 





    5 


    5 





    5 


    5 





















    5 



    5 


    5 
    5 









    5 
    5 
    5 
    1 
    1 






    5 






    1 

    5 


    5 
    5 











    2 


    2 




    2 

    2 
    2 
    2 



    1 


    2 



    2 



    2 





























    2 



    2 



    2 





    2 













    2 
    2 







    2 


    2 





    2 
    2 












































































































































































    1 





   64 

   64 















































    2 
    2 





























































  200 
  200 

   18 


   18 











    5 

    1 
    5 




  232 



  232 

   15 











   19 























1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
// SPDX-License-Identifier: GPL-2.0
/*
 * f2fs compress support
 *
 * Copyright (c) 2019 Chao Yu <chao@kernel.org>
 */

#include <linux/fs.h>
#include <linux/f2fs_fs.h>
#include <linux/moduleparam.h>
#include <linux/writeback.h>
#include <linux/backing-dev.h>
#include <linux/lzo.h>
#include <linux/lz4.h>
#include <linux/zstd.h>
#include <linux/folio_batch.h>
#include <linux/fserror.h>

#include "f2fs.h"
#include "node.h"
#include "segment.h"
#include <trace/events/f2fs.h>

static struct kmem_cache *cic_entry_slab;
static struct kmem_cache *dic_entry_slab;

static void *page_array_alloc(struct f2fs_sb_info *sbi, int nr)
{
        unsigned int size = sizeof(struct page *) * nr;

        if (likely(size <= sbi->page_array_slab_size))
                return f2fs_kmem_cache_alloc(sbi->page_array_slab,
                                        GFP_F2FS_ZERO, false, sbi);
        return f2fs_kzalloc(sbi, size, GFP_NOFS);
}

static void page_array_free(struct f2fs_sb_info *sbi, void *pages, int nr)
{
        unsigned int size = sizeof(struct page *) * nr;

        if (!pages)
                return;

        if (likely(size <= sbi->page_array_slab_size))
                kmem_cache_free(sbi->page_array_slab, pages);
        else
                kfree(pages);
}

struct f2fs_compress_ops {
        int (*init_compress_ctx)(struct compress_ctx *cc);
        void (*destroy_compress_ctx)(struct compress_ctx *cc);
        int (*compress_pages)(struct compress_ctx *cc);
        int (*init_decompress_ctx)(struct decompress_io_ctx *dic);
        void (*destroy_decompress_ctx)(struct decompress_io_ctx *dic);
        int (*decompress_pages)(struct decompress_io_ctx *dic);
        bool (*is_level_valid)(int level);
};

static unsigned int offset_in_cluster(struct compress_ctx *cc, pgoff_t index)
{
        return index & (cc->cluster_size - 1);
}

static pgoff_t cluster_idx(struct compress_ctx *cc, pgoff_t index)
{
        return index >> cc->log_cluster_size;
}

static pgoff_t start_idx_of_cluster(struct compress_ctx *cc)
{
        return cc->cluster_idx << cc->log_cluster_size;
}

bool f2fs_is_compressed_page(struct folio *folio)
{
        if (!folio->private)
                return false;
        if (folio_test_f2fs_nonpointer(folio))
                return false;

        f2fs_bug_on(F2FS_F_SB(folio),
                *((u32 *)folio->private) != F2FS_COMPRESSED_PAGE_MAGIC);
        return true;
}

static void f2fs_set_compressed_page(struct page *page,
                struct inode *inode, pgoff_t index, void *data)
{
        struct folio *folio = page_folio(page);

        folio_attach_private(folio, (void *)data);

        /* i_crypto_info and iv index */
        folio->index = index;
        folio->mapping = inode->i_mapping;
}

static void f2fs_drop_rpages(struct compress_ctx *cc, int len, bool unlock)
{
        int i;

        for (i = 0; i < len; i++) {
                if (!cc->rpages[i])
                        continue;
                if (unlock)
                        unlock_page(cc->rpages[i]);
                else
                        put_page(cc->rpages[i]);
        }
}

static void f2fs_put_rpages(struct compress_ctx *cc)
{
        f2fs_drop_rpages(cc, cc->cluster_size, false);
}

static void f2fs_unlock_rpages(struct compress_ctx *cc, int len)
{
        f2fs_drop_rpages(cc, len, true);
}

static void f2fs_put_rpages_wbc(struct compress_ctx *cc,
                struct writeback_control *wbc, bool redirty, bool unlock)
{
        unsigned int i;

        for (i = 0; i < cc->cluster_size; i++) {
                if (!cc->rpages[i])
                        continue;
                if (redirty)
                        redirty_page_for_writepage(wbc, cc->rpages[i]);
                f2fs_put_page(cc->rpages[i], unlock);
        }
}

struct folio *f2fs_compress_control_folio(struct folio *folio)
{
        struct compress_io_ctx *ctx = folio->private;

        return page_folio(ctx->rpages[0]);
}

int f2fs_init_compress_ctx(struct compress_ctx *cc)
{
        if (cc->rpages)
                return 0;

        cc->rpages = page_array_alloc(F2FS_I_SB(cc->inode), cc->cluster_size);
        return cc->rpages ? 0 : -ENOMEM;
}

void f2fs_destroy_compress_ctx(struct compress_ctx *cc, bool reuse)
{
        page_array_free(F2FS_I_SB(cc->inode), cc->rpages, cc->cluster_size);
        cc->rpages = NULL;
        cc->nr_rpages = 0;
        cc->nr_cpages = 0;
        cc->valid_nr_cpages = 0;
        if (!reuse)
                cc->cluster_idx = NULL_CLUSTER;
}

void f2fs_compress_ctx_add_page(struct compress_ctx *cc, struct folio *folio)
{
        unsigned int cluster_ofs;

        if (!f2fs_cluster_can_merge_page(cc, folio->index))
                f2fs_bug_on(F2FS_I_SB(cc->inode), 1);

        cluster_ofs = offset_in_cluster(cc, folio->index);
        cc->rpages[cluster_ofs] = folio_page(folio, 0);
        cc->nr_rpages++;
        cc->cluster_idx = cluster_idx(cc, folio->index);
}

#ifdef CONFIG_F2FS_FS_LZO
static int lzo_init_compress_ctx(struct compress_ctx *cc)
{
        cc->private = f2fs_vmalloc(F2FS_I_SB(cc->inode),
                                        LZO1X_MEM_COMPRESS);
        if (!cc->private)
                return -ENOMEM;

        cc->clen = lzo1x_worst_compress(PAGE_SIZE << cc->log_cluster_size);
        return 0;
}

static void lzo_destroy_compress_ctx(struct compress_ctx *cc)
{
        vfree(cc->private);
        cc->private = NULL;
}

static int lzo_compress_pages(struct compress_ctx *cc)
{
        int ret;

        ret = lzo1x_1_compress(cc->rbuf, cc->rlen, cc->cbuf->cdata,
                                        &cc->clen, cc->private);
        if (ret != LZO_E_OK) {
                f2fs_err_ratelimited(F2FS_I_SB(cc->inode),
                                "lzo compress failed, ret:%d", ret);
                return -EIO;
        }
        return 0;
}

static int lzo_decompress_pages(struct decompress_io_ctx *dic)
{
        int ret;

        ret = lzo1x_decompress_safe(dic->cbuf->cdata, dic->clen,
                                                dic->rbuf, &dic->rlen);
        if (ret != LZO_E_OK) {
                f2fs_err_ratelimited(dic->sbi,
                                "lzo decompress failed, ret:%d", ret);
                return -EIO;
        }

        if (dic->rlen != PAGE_SIZE << dic->log_cluster_size) {
                f2fs_err_ratelimited(dic->sbi,
                                "lzo invalid rlen:%zu, expected:%lu",
                                dic->rlen, PAGE_SIZE << dic->log_cluster_size);
                return -EIO;
        }
        return 0;
}

static const struct f2fs_compress_ops f2fs_lzo_ops = {
        .init_compress_ctx        = lzo_init_compress_ctx,
        .destroy_compress_ctx        = lzo_destroy_compress_ctx,
        .compress_pages                = lzo_compress_pages,
        .decompress_pages        = lzo_decompress_pages,
};
#endif

#ifdef CONFIG_F2FS_FS_LZ4
static int lz4_init_compress_ctx(struct compress_ctx *cc)
{
        unsigned int size = LZ4_MEM_COMPRESS;

#ifdef CONFIG_F2FS_FS_LZ4HC
        if (F2FS_I(cc->inode)->i_compress_level)
                size = LZ4HC_MEM_COMPRESS;
#endif

        cc->private = f2fs_vmalloc(F2FS_I_SB(cc->inode), size);
        if (!cc->private)
                return -ENOMEM;

        /*
         * we do not change cc->clen to LZ4_compressBound(inputsize) to
         * adapt worst compress case, because lz4 compressor can handle
         * output budget properly.
         */
        cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
        return 0;
}

static void lz4_destroy_compress_ctx(struct compress_ctx *cc)
{
        vfree(cc->private);
        cc->private = NULL;
}

static int lz4_compress_pages(struct compress_ctx *cc)
{
        int len = -EINVAL;
        unsigned char level = F2FS_I(cc->inode)->i_compress_level;

        if (!level)
                len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
                                                cc->clen, cc->private);
#ifdef CONFIG_F2FS_FS_LZ4HC
        else
                len = LZ4_compress_HC(cc->rbuf, cc->cbuf->cdata, cc->rlen,
                                        cc->clen, level, cc->private);
#endif
        if (len < 0)
                return len;
        if (!len)
                return -EAGAIN;

        cc->clen = len;
        return 0;
}

static int lz4_decompress_pages(struct decompress_io_ctx *dic)
{
        int ret;

        ret = LZ4_decompress_safe(dic->cbuf->cdata, dic->rbuf,
                                                dic->clen, dic->rlen);
        if (ret < 0) {
                f2fs_err_ratelimited(dic->sbi,
                                "lz4 decompress failed, ret:%d", ret);
                return -EIO;
        }

        if (ret != PAGE_SIZE << dic->log_cluster_size) {
                f2fs_err_ratelimited(dic->sbi,
                                "lz4 invalid ret:%d, expected:%lu",
                                ret, PAGE_SIZE << dic->log_cluster_size);
                return -EIO;
        }
        return 0;
}

static bool lz4_is_level_valid(int lvl)
{
#ifdef CONFIG_F2FS_FS_LZ4HC
        return !lvl || (lvl >= LZ4HC_MIN_CLEVEL && lvl <= LZ4HC_MAX_CLEVEL);
#else
        return lvl == 0;
#endif
}

static const struct f2fs_compress_ops f2fs_lz4_ops = {
        .init_compress_ctx        = lz4_init_compress_ctx,
        .destroy_compress_ctx        = lz4_destroy_compress_ctx,
        .compress_pages                = lz4_compress_pages,
        .decompress_pages        = lz4_decompress_pages,
        .is_level_valid                = lz4_is_level_valid,
};
#endif

#ifdef CONFIG_F2FS_FS_ZSTD
static int zstd_init_compress_ctx(struct compress_ctx *cc)
{
        zstd_parameters params;
        zstd_cstream *stream;
        void *workspace;
        unsigned int workspace_size;
        unsigned char level = F2FS_I(cc->inode)->i_compress_level;

        /* Need to remain this for backward compatibility */
        if (!level)
                level = F2FS_ZSTD_DEFAULT_CLEVEL;

        params = zstd_get_params(level, cc->rlen);
        workspace_size = zstd_cstream_workspace_bound(&params.cParams);

        workspace = f2fs_vmalloc(F2FS_I_SB(cc->inode), workspace_size);
        if (!workspace)
                return -ENOMEM;

        stream = zstd_init_cstream(&params, 0, workspace, workspace_size);
        if (!stream) {
                f2fs_err_ratelimited(F2FS_I_SB(cc->inode),
                                "%s zstd_init_cstream failed", __func__);
                vfree(workspace);
                return -EIO;
        }

        cc->private = workspace;
        cc->private2 = stream;

        cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
        return 0;
}

static void zstd_destroy_compress_ctx(struct compress_ctx *cc)
{
        vfree(cc->private);
        cc->private = NULL;
        cc->private2 = NULL;
}

static int zstd_compress_pages(struct compress_ctx *cc)
{
        zstd_cstream *stream = cc->private2;
        zstd_in_buffer inbuf;
        zstd_out_buffer outbuf;
        int src_size = cc->rlen;
        int dst_size = src_size - PAGE_SIZE - COMPRESS_HEADER_SIZE;
        int ret;

        inbuf.pos = 0;
        inbuf.src = cc->rbuf;
        inbuf.size = src_size;

        outbuf.pos = 0;
        outbuf.dst = cc->cbuf->cdata;
        outbuf.size = dst_size;

        ret = zstd_compress_stream(stream, &outbuf, &inbuf);
        if (zstd_is_error(ret)) {
                f2fs_err_ratelimited(F2FS_I_SB(cc->inode),
                                "%s zstd_compress_stream failed, ret: %d",
                                __func__, zstd_get_error_code(ret));
                return -EIO;
        }

        ret = zstd_end_stream(stream, &outbuf);
        if (zstd_is_error(ret)) {
                f2fs_err_ratelimited(F2FS_I_SB(cc->inode),
                                "%s zstd_end_stream returned %d",
                                __func__, zstd_get_error_code(ret));
                return -EIO;
        }

        /*
         * there is compressed data remained in intermediate buffer due to
         * no more space in cbuf.cdata
         */
        if (ret)
                return -EAGAIN;

        cc->clen = outbuf.pos;
        return 0;
}

static int zstd_init_decompress_ctx(struct decompress_io_ctx *dic)
{
        zstd_dstream *stream;
        void *workspace;
        unsigned int workspace_size;
        unsigned int max_window_size =
                        MAX_COMPRESS_WINDOW_SIZE(dic->log_cluster_size);

        workspace_size = zstd_dstream_workspace_bound(max_window_size);

        workspace = f2fs_vmalloc(dic->sbi, workspace_size);
        if (!workspace)
                return -ENOMEM;

        stream = zstd_init_dstream(max_window_size, workspace, workspace_size);
        if (!stream) {
                f2fs_err_ratelimited(dic->sbi,
                                "%s zstd_init_dstream failed", __func__);
                vfree(workspace);
                return -EIO;
        }

        dic->private = workspace;
        dic->private2 = stream;

        return 0;
}

static void zstd_destroy_decompress_ctx(struct decompress_io_ctx *dic)
{
        vfree(dic->private);
        dic->private = NULL;
        dic->private2 = NULL;
}

static int zstd_decompress_pages(struct decompress_io_ctx *dic)
{
        zstd_dstream *stream = dic->private2;
        zstd_in_buffer inbuf;
        zstd_out_buffer outbuf;
        int ret;

        inbuf.pos = 0;
        inbuf.src = dic->cbuf->cdata;
        inbuf.size = dic->clen;

        outbuf.pos = 0;
        outbuf.dst = dic->rbuf;
        outbuf.size = dic->rlen;

        ret = zstd_decompress_stream(stream, &outbuf, &inbuf);
        if (zstd_is_error(ret)) {
                f2fs_err_ratelimited(dic->sbi,
                                "%s zstd_decompress_stream failed, ret: %d",
                                __func__, zstd_get_error_code(ret));
                return -EIO;
        }

        if (dic->rlen != outbuf.pos) {
                f2fs_err_ratelimited(dic->sbi,
                                "%s ZSTD invalid rlen:%zu, expected:%lu",
                                __func__, dic->rlen,
                                PAGE_SIZE << dic->log_cluster_size);
                return -EIO;
        }

        return 0;
}

static bool zstd_is_level_valid(int lvl)
{
        return lvl >= zstd_min_clevel() && lvl <= zstd_max_clevel();
}

static const struct f2fs_compress_ops f2fs_zstd_ops = {
        .init_compress_ctx        = zstd_init_compress_ctx,
        .destroy_compress_ctx        = zstd_destroy_compress_ctx,
        .compress_pages                = zstd_compress_pages,
        .init_decompress_ctx        = zstd_init_decompress_ctx,
        .destroy_decompress_ctx        = zstd_destroy_decompress_ctx,
        .decompress_pages        = zstd_decompress_pages,
        .is_level_valid                = zstd_is_level_valid,
};
#endif

#ifdef CONFIG_F2FS_FS_LZO
#ifdef CONFIG_F2FS_FS_LZORLE
static int lzorle_compress_pages(struct compress_ctx *cc)
{
        int ret;

        ret = lzorle1x_1_compress(cc->rbuf, cc->rlen, cc->cbuf->cdata,
                                        &cc->clen, cc->private);
        if (ret != LZO_E_OK) {
                f2fs_err_ratelimited(F2FS_I_SB(cc->inode),
                                "lzo-rle compress failed, ret:%d", ret);
                return -EIO;
        }
        return 0;
}

static const struct f2fs_compress_ops f2fs_lzorle_ops = {
        .init_compress_ctx        = lzo_init_compress_ctx,
        .destroy_compress_ctx        = lzo_destroy_compress_ctx,
        .compress_pages                = lzorle_compress_pages,
        .decompress_pages        = lzo_decompress_pages,
};
#endif
#endif

static const struct f2fs_compress_ops *f2fs_cops[COMPRESS_MAX] = {
#ifdef CONFIG_F2FS_FS_LZO
        &f2fs_lzo_ops,
#else
        NULL,
#endif
#ifdef CONFIG_F2FS_FS_LZ4
        &f2fs_lz4_ops,
#else
        NULL,
#endif
#ifdef CONFIG_F2FS_FS_ZSTD
        &f2fs_zstd_ops,
#else
        NULL,
#endif
#if defined(CONFIG_F2FS_FS_LZO) && defined(CONFIG_F2FS_FS_LZORLE)
        &f2fs_lzorle_ops,
#else
        NULL,
#endif
};

bool f2fs_is_compress_backend_ready(struct inode *inode)
{
        if (!f2fs_compressed_file(inode))
                return true;
        return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
}

bool f2fs_is_compress_level_valid(int alg, int lvl)
{
        const struct f2fs_compress_ops *cops = f2fs_cops[alg];

        if (cops->is_level_valid)
                return cops->is_level_valid(lvl);

        return lvl == 0;
}

static mempool_t *compress_page_pool;
static int num_compress_pages = 512;
module_param(num_compress_pages, uint, 0444);
MODULE_PARM_DESC(num_compress_pages,
                "Number of intermediate compress pages to preallocate");

int __init f2fs_init_compress_mempool(void)
{
        compress_page_pool = mempool_create_page_pool(num_compress_pages, 0);
        return compress_page_pool ? 0 : -ENOMEM;
}

void f2fs_destroy_compress_mempool(void)
{
        mempool_destroy(compress_page_pool);
}

static struct page *f2fs_compress_alloc_page(void)
{
        struct page *page;

        page = mempool_alloc(compress_page_pool, GFP_NOFS);
        lock_page(page);

        return page;
}

static void f2fs_compress_free_page(struct page *page)
{
        struct folio *folio;

        if (!page)
                return;
        folio = page_folio(page);
        folio_detach_private(folio);
        folio->mapping = NULL;
        folio_unlock(folio);
        mempool_free(page, compress_page_pool);
}

#define MAX_VMAP_RETRIES        3

static void *f2fs_vmap(struct page **pages, unsigned int count)
{
        int i;
        void *buf = NULL;

        for (i = 0; i < MAX_VMAP_RETRIES; i++) {
                buf = vm_map_ram(pages, count, -1);
                if (buf)
                        break;
                vm_unmap_aliases();
        }
        return buf;
}

static int f2fs_compress_pages(struct compress_ctx *cc)
{
        struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
        struct f2fs_inode_info *fi = F2FS_I(cc->inode);
        const struct f2fs_compress_ops *cops =
                                f2fs_cops[fi->i_compress_algorithm];
        unsigned int max_len, new_nr_cpages;
        u32 chksum = 0;
        int i, ret;

        trace_f2fs_compress_pages_start(cc->inode, cc->cluster_idx,
                                cc->cluster_size, fi->i_compress_algorithm);

        if (cops->init_compress_ctx) {
                ret = cops->init_compress_ctx(cc);
                if (ret)
                        goto out;
        }

        max_len = COMPRESS_HEADER_SIZE + cc->clen;
        cc->nr_cpages = DIV_ROUND_UP(max_len, PAGE_SIZE);
        cc->valid_nr_cpages = cc->nr_cpages;

        cc->cpages = page_array_alloc(sbi, cc->nr_cpages);
        if (!cc->cpages) {
                ret = -ENOMEM;
                goto destroy_compress_ctx;
        }

        for (i = 0; i < cc->nr_cpages; i++)
                cc->cpages[i] = f2fs_compress_alloc_page();

        cc->rbuf = f2fs_vmap(cc->rpages, cc->cluster_size);
        if (!cc->rbuf) {
                ret = -ENOMEM;
                goto out_free_cpages;
        }

        cc->cbuf = f2fs_vmap(cc->cpages, cc->nr_cpages);
        if (!cc->cbuf) {
                ret = -ENOMEM;
                goto out_vunmap_rbuf;
        }

        ret = cops->compress_pages(cc);
        if (ret)
                goto out_vunmap_cbuf;

        max_len = PAGE_SIZE * (cc->cluster_size - 1) - COMPRESS_HEADER_SIZE;

        if (cc->clen > max_len) {
                ret = -EAGAIN;
                goto out_vunmap_cbuf;
        }

        cc->cbuf->clen = cpu_to_le32(cc->clen);

        if (fi->i_compress_flag & BIT(COMPRESS_CHKSUM))
                chksum = f2fs_crc32(cc->cbuf->cdata, cc->clen);
        cc->cbuf->chksum = cpu_to_le32(chksum);

        for (i = 0; i < COMPRESS_DATA_RESERVED_SIZE; i++)
                cc->cbuf->reserved[i] = cpu_to_le32(0);

        new_nr_cpages = DIV_ROUND_UP(cc->clen + COMPRESS_HEADER_SIZE, PAGE_SIZE);

        /* zero out any unused part of the last page */
        memset(&cc->cbuf->cdata[cc->clen], 0,
                        (new_nr_cpages * PAGE_SIZE) -
                        (cc->clen + COMPRESS_HEADER_SIZE));

        vm_unmap_ram(cc->cbuf, cc->nr_cpages);
        vm_unmap_ram(cc->rbuf, cc->cluster_size);

        for (i = new_nr_cpages; i < cc->nr_cpages; i++) {
                f2fs_compress_free_page(cc->cpages[i]);
                cc->cpages[i] = NULL;
        }

        if (cops->destroy_compress_ctx)
                cops->destroy_compress_ctx(cc);

        cc->valid_nr_cpages = new_nr_cpages;

        trace_f2fs_compress_pages_end(cc->inode, cc->cluster_idx,
                                                        cc->clen, ret);
        return 0;

out_vunmap_cbuf:
        vm_unmap_ram(cc->cbuf, cc->nr_cpages);
out_vunmap_rbuf:
        vm_unmap_ram(cc->rbuf, cc->cluster_size);
out_free_cpages:
        for (i = 0; i < cc->nr_cpages; i++) {
                if (cc->cpages[i])
                        f2fs_compress_free_page(cc->cpages[i]);
        }
        page_array_free(sbi, cc->cpages, cc->nr_cpages);
        cc->cpages = NULL;
destroy_compress_ctx:
        if (cops->destroy_compress_ctx)
                cops->destroy_compress_ctx(cc);
out:
        trace_f2fs_compress_pages_end(cc->inode, cc->cluster_idx,
                                                        cc->clen, ret);
        return ret;
}

static int f2fs_prepare_decomp_mem(struct decompress_io_ctx *dic,
                bool pre_alloc);
static void f2fs_release_decomp_mem(struct decompress_io_ctx *dic,
                bool bypass_destroy_callback, bool pre_alloc);

void f2fs_decompress_cluster(struct decompress_io_ctx *dic, bool in_task)
{
        struct f2fs_sb_info *sbi = dic->sbi;
        struct f2fs_inode_info *fi = F2FS_I(dic->inode);
        const struct f2fs_compress_ops *cops =
                        f2fs_cops[fi->i_compress_algorithm];
        bool bypass_callback = false;
        int ret;

        trace_f2fs_decompress_pages_start(dic->inode, dic->cluster_idx,
                                dic->cluster_size, fi->i_compress_algorithm);

        if (dic->failed) {
                ret = -EIO;
                goto out_end_io;
        }

        ret = f2fs_prepare_decomp_mem(dic, false);
        if (ret) {
                bypass_callback = true;
                goto out_release;
        }

        dic->clen = le32_to_cpu(dic->cbuf->clen);
        dic->rlen = PAGE_SIZE << dic->log_cluster_size;

        if (dic->clen > PAGE_SIZE * dic->nr_cpages - COMPRESS_HEADER_SIZE) {
                ret = -EFSCORRUPTED;

                /* Avoid f2fs_commit_super in irq context */
                f2fs_handle_error(sbi, ERROR_FAIL_DECOMPRESSION);
                fserror_report_file_metadata(dic->inode, ret, GFP_NOFS);
                goto out_release;
        }

        ret = cops->decompress_pages(dic);

        if (!ret && (fi->i_compress_flag & BIT(COMPRESS_CHKSUM))) {
                u32 provided = le32_to_cpu(dic->cbuf->chksum);
                u32 calculated = f2fs_crc32(dic->cbuf->cdata, dic->clen);

                if (provided != calculated) {
                        if (!is_inode_flag_set(dic->inode, FI_COMPRESS_CORRUPT)) {
                                set_inode_flag(dic->inode, FI_COMPRESS_CORRUPT);
                                f2fs_info_ratelimited(sbi,
                                        "checksum invalid, nid = %llu, %x vs %x",
                                        dic->inode->i_ino,
                                        provided, calculated);
                        }
                        set_sbi_flag(sbi, SBI_NEED_FSCK);
                }
        }

out_release:
        f2fs_release_decomp_mem(dic, bypass_callback, false);

out_end_io:
        trace_f2fs_decompress_pages_end(dic->inode, dic->cluster_idx,
                                                        dic->clen, ret);
        f2fs_decompress_end_io(dic, ret, in_task);
}

static void f2fs_cache_compressed_page(struct f2fs_sb_info *sbi,
                struct folio *folio, nid_t ino, block_t blkaddr);

/*
 * This is called when a page of a compressed cluster has been read from disk
 * (or failed to be read from disk).  It checks whether this page was the last
 * page being waited on in the cluster, and if so, it decompresses the cluster
 * (or in the case of a failure, cleans up without actually decompressing).
 */
void f2fs_end_read_compressed_page(struct folio *folio, bool failed,
                block_t blkaddr, bool in_task)
{
        struct decompress_io_ctx *dic = folio->private;
        struct f2fs_sb_info *sbi = dic->sbi;

        dec_page_count(sbi, F2FS_RD_DATA);

        if (failed)
                WRITE_ONCE(dic->failed, true);
        else if (blkaddr && in_task)
                f2fs_cache_compressed_page(sbi, folio,
                                        dic->inode->i_ino, blkaddr);

        if (atomic_dec_and_test(&dic->remaining_pages))
                f2fs_decompress_cluster(dic, in_task);
}

static bool is_page_in_cluster(struct compress_ctx *cc, pgoff_t index)
{
        if (cc->cluster_idx == NULL_CLUSTER)
                return true;
        return cc->cluster_idx == cluster_idx(cc, index);
}

bool f2fs_cluster_is_empty(struct compress_ctx *cc)
{
        return cc->nr_rpages == 0;
}

static bool f2fs_cluster_is_full(struct compress_ctx *cc)
{
        return cc->cluster_size == cc->nr_rpages;
}

bool f2fs_cluster_can_merge_page(struct compress_ctx *cc, pgoff_t index)
{
        if (f2fs_cluster_is_empty(cc))
                return true;
        return is_page_in_cluster(cc, index);
}

bool f2fs_all_cluster_page_ready(struct compress_ctx *cc, struct page **pages,
                                int index, int nr_pages, bool uptodate)
{
        unsigned long pgidx = page_folio(pages[index])->index;
        int i = uptodate ? 0 : 1;

        /*
         * when uptodate set to true, try to check all pages in cluster is
         * uptodate or not.
         */
        if (uptodate && (pgidx % cc->cluster_size))
                return false;

        if (nr_pages - index < cc->cluster_size)
                return false;

        for (; i < cc->cluster_size; i++) {
                struct folio *folio = page_folio(pages[index + i]);

                if (folio->index != pgidx + i)
                        return false;
                if (uptodate && !folio_test_uptodate(folio))
                        return false;
        }

        return true;
}

static bool cluster_has_invalid_data(struct compress_ctx *cc)
{
        loff_t i_size = i_size_read(cc->inode);
        unsigned nr_pages = DIV_ROUND_UP(i_size, PAGE_SIZE);
        int i;

        for (i = 0; i < cc->cluster_size; i++) {
                struct page *page = cc->rpages[i];

                f2fs_bug_on(F2FS_I_SB(cc->inode), !page);

                /* beyond EOF */
                if (page_folio(page)->index >= nr_pages)
                        return true;
        }
        return false;
}

bool f2fs_sanity_check_cluster(struct dnode_of_data *dn)
{
#ifdef CONFIG_F2FS_CHECK_FS
        struct f2fs_sb_info *sbi = F2FS_I_SB(dn->inode);
        unsigned int cluster_size = F2FS_I(dn->inode)->i_cluster_size;
        int cluster_end = 0;
        unsigned int count;
        int i;
        char *reason = "";

        if (dn->data_blkaddr != COMPRESS_ADDR)
                return false;

        /* [..., COMPR_ADDR, ...] */
        if (dn->ofs_in_node % cluster_size) {
                reason = "[*|C|*|*]";
                goto out;
        }

        for (i = 1, count = 1; i < cluster_size; i++, count++) {
                block_t blkaddr = data_blkaddr(dn->inode, dn->node_folio,
                                                        dn->ofs_in_node + i);

                /* [COMPR_ADDR, ..., COMPR_ADDR] */
                if (blkaddr == COMPRESS_ADDR) {
                        reason = "[C|*|C|*]";
                        goto out;
                }
                if (!__is_valid_data_blkaddr(blkaddr)) {
                        if (!cluster_end)
                                cluster_end = i;
                        continue;
                }
                /* [COMPR_ADDR, NULL_ADDR or NEW_ADDR, valid_blkaddr] */
                if (cluster_end) {
                        reason = "[C|N|N|V]";
                        goto out;
                }
        }

        f2fs_bug_on(F2FS_I_SB(dn->inode), count != cluster_size &&
                !is_inode_flag_set(dn->inode, FI_COMPRESS_RELEASED));

        return false;
out:
        f2fs_warn(sbi, "access invalid cluster, ino:%llu, nid:%u, ofs_in_node:%u, reason:%s",
                        dn->inode->i_ino, dn->nid, dn->ofs_in_node, reason);
        set_sbi_flag(sbi, SBI_NEED_FSCK);
        return true;
#else
        return false;
#endif
}

static int __f2fs_get_cluster_blocks(struct inode *inode,
                                        struct dnode_of_data *dn)
{
        unsigned int cluster_size = F2FS_I(inode)->i_cluster_size;
        int count, i;

        for (i = 0, count = 0; i < cluster_size; i++) {
                block_t blkaddr = data_blkaddr(dn->inode, dn->node_folio,
                                                        dn->ofs_in_node + i);

                if (__is_valid_data_blkaddr(blkaddr))
                        count++;
        }

        return count;
}

static int __f2fs_cluster_blocks(struct inode *inode, unsigned int cluster_idx,
                                enum cluster_check_type type)
{
        struct dnode_of_data dn;
        unsigned int start_idx = cluster_idx <<
                                F2FS_I(inode)->i_log_cluster_size;
        int ret;

        set_new_dnode(&dn, inode, NULL, NULL, 0);
        ret = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
        if (ret) {
                if (ret == -ENOENT)
                        ret = 0;
                goto fail;
        }

        if (f2fs_sanity_check_cluster(&dn)) {
                ret = -EFSCORRUPTED;
                goto fail;
        }

        if (dn.data_blkaddr == COMPRESS_ADDR) {
                if (type == CLUSTER_COMPR_BLKS)
                        ret = 1 + __f2fs_get_cluster_blocks(inode, &dn);
                else if (type == CLUSTER_IS_COMPR)
                        ret = 1;
        } else if (type == CLUSTER_RAW_BLKS) {
                ret = __f2fs_get_cluster_blocks(inode, &dn);
        }
fail:
        f2fs_put_dnode(&dn);
        return ret;
}

/* return # of compressed blocks in compressed cluster */
static int f2fs_compressed_blocks(struct compress_ctx *cc)
{
        return __f2fs_cluster_blocks(cc->inode, cc->cluster_idx,
                CLUSTER_COMPR_BLKS);
}

/* return # of raw blocks in non-compressed cluster */
static int f2fs_decompressed_blocks(struct inode *inode,
                                unsigned int cluster_idx)
{
        return __f2fs_cluster_blocks(inode, cluster_idx,
                CLUSTER_RAW_BLKS);
}

/* return whether cluster is compressed one or not */
int f2fs_is_compressed_cluster(struct inode *inode, pgoff_t index)
{
        return __f2fs_cluster_blocks(inode,
                index >> F2FS_I(inode)->i_log_cluster_size,
                CLUSTER_IS_COMPR);
}

/* return whether cluster contains non raw blocks or not */
bool f2fs_is_sparse_cluster(struct inode *inode, pgoff_t index)
{
        unsigned int cluster_idx = index >> F2FS_I(inode)->i_log_cluster_size;

        return f2fs_decompressed_blocks(inode, cluster_idx) !=
                F2FS_I(inode)->i_cluster_size;
}

static bool cluster_may_compress(struct compress_ctx *cc)
{
        if (!f2fs_need_compress_data(cc->inode))
                return false;
        if (f2fs_is_atomic_file(cc->inode))
                return false;
        if (!f2fs_cluster_is_full(cc))
                return false;
        if (unlikely(f2fs_cp_error(F2FS_I_SB(cc->inode))))
                return false;
        return !cluster_has_invalid_data(cc);
}

static void set_cluster_writeback(struct compress_ctx *cc)
{
        int i;

        for (i = 0; i < cc->cluster_size; i++) {
                if (cc->rpages[i])
                        set_page_writeback(cc->rpages[i]);
        }
}

static void cancel_cluster_writeback(struct compress_ctx *cc,
                        struct compress_io_ctx *cic, int submitted)
{
        int i;

        /* Wait for submitted IOs. */
        if (submitted > 1) {
                f2fs_submit_merged_write(F2FS_I_SB(cc->inode), DATA);
                while (atomic_read(&cic->pending_pages) !=
                                        (cc->valid_nr_cpages - submitted + 1))
                        f2fs_io_schedule_timeout(DEFAULT_SCHEDULE_TIMEOUT);
        }

        /* Cancel writeback and stay locked. */
        for (i = 0; i < cc->cluster_size; i++) {
                if (i < submitted) {
                        inode_inc_dirty_pages(cc->inode);
                        lock_page(cc->rpages[i]);
                }
                clear_page_private_gcing(cc->rpages[i]);
                if (folio_test_writeback(page_folio(cc->rpages[i])))
                        end_page_writeback(cc->rpages[i]);
        }
}

static void set_cluster_dirty(struct compress_ctx *cc)
{
        int i;

        for (i = 0; i < cc->cluster_size; i++)
                if (cc->rpages[i]) {
                        set_page_dirty(cc->rpages[i]);
                        set_page_private_gcing(cc->rpages[i]);
                }
}

static int prepare_compress_overwrite(struct compress_ctx *cc,
                struct page **pagep, pgoff_t index, void **fsdata)
{
        struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
        struct address_space *mapping = cc->inode->i_mapping;
        struct folio *folio;
        sector_t last_block_in_bio;
        fgf_t fgp_flag = FGP_LOCK | FGP_WRITE | FGP_CREAT;
        pgoff_t start_idx = start_idx_of_cluster(cc);
        int i, ret;

retry:
        ret = f2fs_is_compressed_cluster(cc->inode, start_idx);
        if (ret <= 0)
                return ret;

        ret = f2fs_init_compress_ctx(cc);
        if (ret)
                return ret;

        /* keep folio reference to avoid page reclaim */
        for (i = 0; i < cc->cluster_size; i++) {
                folio = f2fs_filemap_get_folio(mapping, start_idx + i,
                                fgp_flag, GFP_NOFS);
                if (IS_ERR(folio)) {
                        ret = PTR_ERR(folio);
                        goto unlock_pages;
                }

                if (folio_test_uptodate(folio))
                        f2fs_folio_put(folio, true);
                else
                        f2fs_compress_ctx_add_page(cc, folio);
        }

        if (!f2fs_cluster_is_empty(cc)) {
                struct bio *bio = NULL;

                ret = f2fs_read_multi_pages(cc, &bio, cc->cluster_size,
                                        &last_block_in_bio, NULL, true);
                f2fs_put_rpages(cc);
                f2fs_destroy_compress_ctx(cc, true);
                if (ret)
                        goto out;
                if (bio)
                        f2fs_submit_read_bio(sbi, bio, DATA);

                ret = f2fs_init_compress_ctx(cc);
                if (ret)
                        goto out;
        }

        for (i = 0; i < cc->cluster_size; i++) {
                f2fs_bug_on(sbi, cc->rpages[i]);

                folio = filemap_lock_folio(mapping, start_idx + i);
                if (IS_ERR(folio)) {
                        /* folio could be truncated */
                        goto release_and_retry;
                }

                f2fs_folio_wait_writeback(folio, DATA, true, true);
                f2fs_compress_ctx_add_page(cc, folio);

                if (!folio_test_uptodate(folio)) {
                        f2fs_handle_page_eio(sbi, folio, DATA);
release_and_retry:
                        f2fs_put_rpages(cc);
                        f2fs_unlock_rpages(cc, i + 1);
                        f2fs_destroy_compress_ctx(cc, true);
                        goto retry;
                }
        }

        if (likely(!ret)) {
                *fsdata = cc->rpages;
                *pagep = cc->rpages[offset_in_cluster(cc, index)];
                return cc->cluster_size;
        }

unlock_pages:
        f2fs_put_rpages(cc);
        f2fs_unlock_rpages(cc, i);
        f2fs_destroy_compress_ctx(cc, true);
out:
        return ret;
}

int f2fs_prepare_compress_overwrite(struct inode *inode,
                struct page **pagep, pgoff_t index, void **fsdata)
{
        struct compress_ctx cc = {
                .inode = inode,
                .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
                .cluster_size = F2FS_I(inode)->i_cluster_size,
                .cluster_idx = index >> F2FS_I(inode)->i_log_cluster_size,
                .rpages = NULL,
                .nr_rpages = 0,
                .vi = NULL, /* can't write to fsverity files */
        };

        return prepare_compress_overwrite(&cc, pagep, index, fsdata);
}

bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
                                        pgoff_t index, unsigned copied)

{
        struct compress_ctx cc = {
                .inode = inode,
                .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
                .cluster_size = F2FS_I(inode)->i_cluster_size,
                .rpages = fsdata,
        };
        struct folio *folio = page_folio(cc.rpages[0]);
        bool first_index = (index == folio->index);

        if (copied)
                set_cluster_dirty(&cc);

        f2fs_put_rpages_wbc(&cc, NULL, false, true);
        f2fs_destroy_compress_ctx(&cc, false);

        return first_index;
}

int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock)
{
        void *fsdata = NULL;
        struct page *pagep;
        struct page **rpages;
        int log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
        pgoff_t start_idx = from >> (PAGE_SHIFT + log_cluster_size) <<
                                                        log_cluster_size;
        int i;
        int err;

        err = f2fs_is_compressed_cluster(inode, start_idx);
        if (err < 0)
                return err;

        /* truncate normal cluster */
        if (!err)
                return f2fs_do_truncate_blocks(inode, from, lock);

        /* truncate compressed cluster */
        err = f2fs_prepare_compress_overwrite(inode, &pagep,
                                                start_idx, &fsdata);

        /* should not be a normal cluster */
        f2fs_bug_on(F2FS_I_SB(inode), err == 0);

        if (err <= 0)
                return err;

        rpages = fsdata;

        for (i = (1 << log_cluster_size) - 1; i >= 0; i--) {
                struct folio *folio = page_folio(rpages[i]);
                loff_t start = (loff_t)folio->index << PAGE_SHIFT;
                loff_t offset = from > start ? from - start : 0;

                folio_zero_segment(folio, offset, folio_size(folio));

                if (from >= start)
                        break;
        }

        f2fs_compress_write_end(inode, fsdata, start_idx, true);

        err = filemap_write_and_wait_range(inode->i_mapping,
                        round_down(from, 1 << log_cluster_size << PAGE_SHIFT),
                        LLONG_MAX);
        if (err)
                return err;

        truncate_pagecache(inode, from);

        return f2fs_do_truncate_blocks(inode, round_up(from, PAGE_SIZE), lock);
}

static int f2fs_write_compressed_pages(struct compress_ctx *cc,
                                        int *submitted,
                                        struct writeback_control *wbc,
                                        enum iostat_type io_type)
{
        struct inode *inode = cc->inode;
        struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
        struct f2fs_inode_info *fi = F2FS_I(inode);
        struct f2fs_io_info fio = {
                .sbi = sbi,
                .ino = cc->inode->i_ino,
                .type = DATA,
                .op = REQ_OP_WRITE,
                .op_flags = wbc_to_write_flags(wbc),
                .old_blkaddr = NEW_ADDR,
                .page = NULL,
                .encrypted_page = NULL,
                .compressed_page = NULL,
                .io_type = io_type,
                .io_wbc = wbc,
                .encrypted = fscrypt_inode_uses_fs_layer_crypto(cc->inode) ?
                                                                        1 : 0,
        };
        struct folio *folio;
        struct dnode_of_data dn;
        struct node_info ni;
        struct compress_io_ctx *cic;
        struct f2fs_lock_context lc;
        pgoff_t start_idx = start_idx_of_cluster(cc);
        unsigned int last_index = cc->cluster_size - 1;
        loff_t psize;
        int i, err;
        bool quota_inode = IS_NOQUOTA(inode);

        /* we should bypass data pages to proceed the kworker jobs */
        if (unlikely(f2fs_cp_error(sbi))) {
                mapping_set_error(inode->i_mapping, -EIO);
                goto out_free;
        }

        if (quota_inode) {
                /*
                 * We need to wait for node_write to avoid block allocation during
                 * checkpoint. This can only happen to quota writes which can cause
                 * the below discard race condition.
                 */
                f2fs_down_read_trace(&sbi->node_write, &lc);
        } else if (!f2fs_trylock_op(sbi, &lc)) {
                goto out_free;
        }

        set_new_dnode(&dn, cc->inode, NULL, NULL, 0);

        err = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
        if (err)
                goto out_unlock_op;

        for (i = 0; i < cc->cluster_size; i++) {
                if (data_blkaddr(dn.inode, dn.node_folio,
                                        dn.ofs_in_node + i) == NULL_ADDR)
                        goto out_put_dnode;
        }

        folio = page_folio(cc->rpages[last_index]);
        psize = folio_next_pos(folio);

        err = f2fs_get_node_info(fio.sbi, dn.nid, &ni, false);
        if (err)
                goto out_put_dnode;

        fio.version = ni.version;

        cic = f2fs_kmem_cache_alloc(cic_entry_slab, GFP_F2FS_ZERO, false, sbi);
        if (!cic)
                goto out_put_dnode;

        cic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
        cic->inode = inode;
        atomic_set(&cic->pending_pages, cc->valid_nr_cpages);
        cic->rpages = page_array_alloc(sbi, cc->cluster_size);
        if (!cic->rpages)
                goto out_put_cic;

        cic->nr_rpages = cc->cluster_size;

        for (i = 0; i < cc->valid_nr_cpages; i++) {
                f2fs_set_compressed_page(cc->cpages[i], inode,
                                page_folio(cc->rpages[i + 1])->index, cic);
                fio.compressed_page = cc->cpages[i];

                fio.old_blkaddr = data_blkaddr(dn.inode, dn.node_folio,
                                                dn.ofs_in_node + i + 1);

                /* wait for GCed page writeback via META_MAPPING */
                f2fs_wait_on_block_writeback(inode, fio.old_blkaddr);

                if (fio.encrypted) {
                        fio.page = cc->rpages[i + 1];
                        err = f2fs_encrypt_one_page(&fio);
                        if (err)
                                goto out_destroy_crypt;
                        cc->cpages[i] = fio.encrypted_page;
                }
        }

        set_cluster_writeback(cc);

        for (i = 0; i < cc->cluster_size; i++)
                cic->rpages[i] = cc->rpages[i];

        for (i = 0; i < cc->cluster_size; i++, dn.ofs_in_node++) {
                block_t blkaddr;

                blkaddr = f2fs_data_blkaddr(&dn);
                fio.page = cc->rpages[i];
                fio.old_blkaddr = blkaddr;

                /* cluster header */
                if (i == 0) {
                        if (blkaddr == COMPRESS_ADDR)
                                fio.compr_blocks++;
                        if (__is_valid_data_blkaddr(blkaddr))
                                f2fs_invalidate_blocks(sbi, blkaddr, 1);
                        f2fs_update_data_blkaddr(&dn, COMPRESS_ADDR);
                        goto unlock_continue;
                }

                if (fio.compr_blocks && __is_valid_data_blkaddr(blkaddr))
                        fio.compr_blocks++;

                if (i > cc->valid_nr_cpages) {
                        if (__is_valid_data_blkaddr(blkaddr)) {
                                f2fs_invalidate_blocks(sbi, blkaddr, 1);
                                f2fs_update_data_blkaddr(&dn, NEW_ADDR);
                        }
                        goto unlock_continue;
                }

                f2fs_bug_on(fio.sbi, blkaddr == NULL_ADDR);

                if (fio.encrypted)
                        fio.encrypted_page = cc->cpages[i - 1];
                else
                        fio.compressed_page = cc->cpages[i - 1];

                cc->cpages[i - 1] = NULL;
                fio.submitted = 0;
                f2fs_outplace_write_data(&dn, &fio);
                if (unlikely(!fio.submitted)) {
                        cancel_cluster_writeback(cc, cic, i);

                        /* To call fscrypt_finalize_bounce_page */
                        i = cc->valid_nr_cpages;
                        *submitted = 0;
                        goto out_destroy_crypt;
                }
                (*submitted)++;
unlock_continue:
                inode_dec_dirty_pages(cc->inode);
                folio_unlock(fio.folio);
        }

        if (fio.compr_blocks)
                f2fs_i_compr_blocks_update(inode, fio.compr_blocks - 1, false);
        f2fs_i_compr_blocks_update(inode, cc->valid_nr_cpages, true);
        add_compr_block_stat(inode, cc->valid_nr_cpages);

        set_inode_flag(cc->inode, FI_APPEND_WRITE);

        f2fs_put_dnode(&dn);
        if (quota_inode)
                f2fs_up_read_trace(&sbi->node_write, &lc);
        else
                f2fs_unlock_op(sbi, &lc);

        spin_lock(&fi->i_size_lock);
        if (fi->last_disk_size < psize)
                fi->last_disk_size = psize;
        spin_unlock(&fi->i_size_lock);

        f2fs_put_rpages(cc);
        page_array_free(sbi, cc->cpages, cc->nr_cpages);
        cc->cpages = NULL;
        f2fs_destroy_compress_ctx(cc, false);
        return 0;

out_destroy_crypt:
        page_array_free(sbi, cic->rpages, cc->cluster_size);

        if (!fio.encrypted)
                goto out_put_cic;

        for (--i; i >= 0; i--) {
                if (!cc->cpages[i])
                        continue;
                fscrypt_finalize_bounce_page(&cc->cpages[i]);
        }
out_put_cic:
        kmem_cache_free(cic_entry_slab, cic);
out_put_dnode:
        f2fs_put_dnode(&dn);
out_unlock_op:
        if (quota_inode)
                f2fs_up_read_trace(&sbi->node_write, &lc);
        else
                f2fs_unlock_op(sbi, &lc);
out_free:
        for (i = 0; i < cc->valid_nr_cpages; i++) {
                f2fs_compress_free_page(cc->cpages[i]);
                cc->cpages[i] = NULL;
        }
        page_array_free(sbi, cc->cpages, cc->nr_cpages);
        cc->cpages = NULL;
        return -EAGAIN;
}

void f2fs_compress_write_end_io(struct bio *bio, struct folio *folio)
{
        struct page *page = &folio->page;
        struct f2fs_sb_info *sbi = bio->bi_private;
        struct compress_io_ctx *cic = folio->private;
        enum count_type type = WB_DATA_TYPE(folio, true);
        int i;

        if (unlikely(bio->bi_status != BLK_STS_OK))
                mapping_set_error(cic->inode->i_mapping, -EIO);

        f2fs_compress_free_page(page);

        if (atomic_dec_return(&cic->pending_pages)) {
                dec_page_count(sbi, type);
                return;
        }

        for (i = 0; i < cic->nr_rpages; i++) {
                WARN_ON(!cic->rpages[i]);
                clear_page_private_gcing(cic->rpages[i]);
                end_page_writeback(cic->rpages[i]);
        }

        page_array_free(sbi, cic->rpages, cic->nr_rpages);
        kmem_cache_free(cic_entry_slab, cic);

        /*
         * Make sure dec_page_count() is the last access to sbi.
         * Once it drops the F2FS_WB_CP_DATA counter to zero, the
         * unmount thread can proceed to destroy sbi and
         * sbi->page_array_slab.
         */
        dec_page_count(sbi, type);
}

static int f2fs_write_raw_pages(struct compress_ctx *cc,
                                        int *submitted_p,
                                        struct writeback_control *wbc,
                                        enum iostat_type io_type)
{
        struct address_space *mapping = cc->inode->i_mapping;
        struct f2fs_sb_info *sbi = F2FS_M_SB(mapping);
        struct f2fs_lock_context lc;
        int submitted, compr_blocks, i;
        int ret = 0;

        compr_blocks = f2fs_compressed_blocks(cc);

        for (i = 0; i < cc->cluster_size; i++) {
                if (!cc->rpages[i])
                        continue;

                redirty_page_for_writepage(wbc, cc->rpages[i]);
                unlock_page(cc->rpages[i]);
        }

        if (compr_blocks < 0)
                return compr_blocks;

        /* overwrite compressed cluster w/ normal cluster */
        if (compr_blocks > 0)
                f2fs_lock_op(sbi, &lc);

        for (i = 0; i < cc->cluster_size; i++) {
                struct folio *folio;

                if (!cc->rpages[i])
                        continue;
                folio = page_folio(cc->rpages[i]);
retry_write:
                folio_lock(folio);

                if (folio->mapping != mapping) {
continue_unlock:
                        folio_unlock(folio);
                        continue;
                }

                if (!folio_test_dirty(folio))
                        goto continue_unlock;

                if (folio_test_writeback(folio)) {
                        if (wbc->sync_mode == WB_SYNC_NONE)
                                goto continue_unlock;
                        f2fs_folio_wait_writeback(folio, DATA, true, true);
                }

                if (!folio_clear_dirty_for_io(folio))
                        goto continue_unlock;

                submitted = 0;
                ret = f2fs_write_single_data_page(folio, &submitted,
                                                NULL, NULL, wbc, io_type,
                                                compr_blocks, false);
                if (ret) {
                        if (ret == 1) {
                                ret = 0;
                        } else if (ret == -EAGAIN) {
                                ret = 0;
                                /*
                                 * for quota file, just redirty left pages to
                                 * avoid deadlock caused by cluster update race
                                 * from foreground operation.
                                 */
                                if (IS_NOQUOTA(cc->inode))
                                        goto out;
                                f2fs_schedule_timeout(DEFAULT_SCHEDULE_TIMEOUT);
                                goto retry_write;
                        }
                        goto out;
                }

                *submitted_p += submitted;
        }

out:
        if (compr_blocks > 0)
                f2fs_unlock_op(sbi, &lc);

        f2fs_balance_fs(sbi, true);
        return ret;
}

int f2fs_write_multi_pages(struct compress_ctx *cc,
                                        int *submitted,
                                        struct writeback_control *wbc,
                                        enum iostat_type io_type)
{
        int err;

        *submitted = 0;
        if (cluster_may_compress(cc)) {
                err = f2fs_compress_pages(cc);
                if (err == -EAGAIN) {
                        add_compr_block_stat(cc->inode, cc->cluster_size);
                        goto write;
                } else if (err) {
                        f2fs_put_rpages_wbc(cc, wbc, true, true);
                        goto destroy_out;
                }

                err = f2fs_write_compressed_pages(cc, submitted,
                                                        wbc, io_type);
                if (!err)
                        return 0;
                f2fs_bug_on(F2FS_I_SB(cc->inode), err != -EAGAIN);
        }
write:
        f2fs_bug_on(F2FS_I_SB(cc->inode), *submitted);

        err = f2fs_write_raw_pages(cc, submitted, wbc, io_type);
        f2fs_put_rpages_wbc(cc, wbc, false, false);
destroy_out:
        f2fs_destroy_compress_ctx(cc, false);
        return err;
}

static inline bool allow_memalloc_for_decomp(struct f2fs_sb_info *sbi,
                bool pre_alloc)
{
        return pre_alloc ^ f2fs_low_mem_mode(sbi);
}

static int f2fs_prepare_decomp_mem(struct decompress_io_ctx *dic,
                bool pre_alloc)
{
        const struct f2fs_compress_ops *cops = f2fs_cops[dic->compress_algorithm];
        int i;

        if (!allow_memalloc_for_decomp(dic->sbi, pre_alloc))
                return 0;

        dic->tpages = page_array_alloc(dic->sbi, dic->cluster_size);
        if (!dic->tpages)
                return -ENOMEM;

        for (i = 0; i < dic->cluster_size; i++) {
                if (dic->rpages[i]) {
                        dic->tpages[i] = dic->rpages[i];
                        continue;
                }

                dic->tpages[i] = f2fs_compress_alloc_page();
        }

        dic->rbuf = f2fs_vmap(dic->tpages, dic->cluster_size);
        if (!dic->rbuf)
                return -ENOMEM;

        dic->cbuf = f2fs_vmap(dic->cpages, dic->nr_cpages);
        if (!dic->cbuf)
                return -ENOMEM;

        if (cops->init_decompress_ctx)
                return cops->init_decompress_ctx(dic);

        return 0;
}

static void f2fs_release_decomp_mem(struct decompress_io_ctx *dic,
                bool bypass_destroy_callback, bool pre_alloc)
{
        const struct f2fs_compress_ops *cops = f2fs_cops[dic->compress_algorithm];

        if (!allow_memalloc_for_decomp(dic->sbi, pre_alloc))
                return;

        if (!bypass_destroy_callback && cops->destroy_decompress_ctx)
                cops->destroy_decompress_ctx(dic);

        if (dic->cbuf)
                vm_unmap_ram(dic->cbuf, dic->nr_cpages);

        if (dic->rbuf)
                vm_unmap_ram(dic->rbuf, dic->cluster_size);
}

static void f2fs_free_dic(struct decompress_io_ctx *dic,
                bool bypass_destroy_callback);

struct decompress_io_ctx *f2fs_alloc_dic(struct compress_ctx *cc)
{
        struct decompress_io_ctx *dic;
        pgoff_t start_idx = start_idx_of_cluster(cc);
        struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
        int i, ret;

        dic = f2fs_kmem_cache_alloc(dic_entry_slab, GFP_F2FS_ZERO, false, sbi);
        if (!dic)
                return ERR_PTR(-ENOMEM);

        dic->rpages = page_array_alloc(sbi, cc->cluster_size);
        if (!dic->rpages) {
                kmem_cache_free(dic_entry_slab, dic);
                return ERR_PTR(-ENOMEM);
        }

        dic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
        dic->inode = cc->inode;
        dic->sbi = sbi;
        dic->compress_algorithm = F2FS_I(cc->inode)->i_compress_algorithm;
        atomic_set(&dic->remaining_pages, cc->nr_cpages);
        dic->cluster_idx = cc->cluster_idx;
        dic->cluster_size = cc->cluster_size;
        dic->log_cluster_size = cc->log_cluster_size;
        dic->nr_cpages = cc->nr_cpages;
        refcount_set(&dic->refcnt, 1);
        dic->failed = false;
        dic->vi = cc->vi;

        for (i = 0; i < dic->cluster_size; i++)
                dic->rpages[i] = cc->rpages[i];
        dic->nr_rpages = cc->cluster_size;

        dic->cpages = page_array_alloc(sbi, dic->nr_cpages);
        if (!dic->cpages) {
                ret = -ENOMEM;
                goto out_free;
        }

        for (i = 0; i < dic->nr_cpages; i++) {
                struct page *page;

                page = f2fs_compress_alloc_page();
                f2fs_set_compressed_page(page, cc->inode,
                                        start_idx + i + 1, dic);
                dic->cpages[i] = page;
        }

        ret = f2fs_prepare_decomp_mem(dic, true);
        if (ret)
                goto out_free;

        return dic;

out_free:
        f2fs_free_dic(dic, true);
        return ERR_PTR(ret);
}

static void f2fs_free_dic(struct decompress_io_ctx *dic,
                bool bypass_destroy_callback)
{
        int i;
        /* use sbi in dic to avoid UFA of dic->inode*/
        struct f2fs_sb_info *sbi = dic->sbi;

        f2fs_release_decomp_mem(dic, bypass_destroy_callback, true);

        if (dic->tpages) {
                for (i = 0; i < dic->cluster_size; i++) {
                        if (dic->rpages[i])
                                continue;
                        if (!dic->tpages[i])
                                continue;
                        f2fs_compress_free_page(dic->tpages[i]);
                }
                page_array_free(sbi, dic->tpages, dic->cluster_size);
        }

        if (dic->cpages) {
                for (i = 0; i < dic->nr_cpages; i++) {
                        if (!dic->cpages[i])
                                continue;
                        f2fs_compress_free_page(dic->cpages[i]);
                }
                page_array_free(sbi, dic->cpages, dic->nr_cpages);
        }

        page_array_free(sbi, dic->rpages, dic->nr_rpages);
        kmem_cache_free(dic_entry_slab, dic);
}

static void f2fs_late_free_dic(struct work_struct *work)
{
        struct decompress_io_ctx *dic =
                container_of(work, struct decompress_io_ctx, free_work);

        f2fs_free_dic(dic, false);
}

static void f2fs_put_dic(struct decompress_io_ctx *dic, bool in_task)
{
        if (refcount_dec_and_test(&dic->refcnt)) {
                if (in_task) {
                        f2fs_free_dic(dic, false);
                } else {
                        INIT_WORK(&dic->free_work, f2fs_late_free_dic);
                        queue_work(dic->sbi->wq, &dic->free_work);
                }
        }
}

static void f2fs_verify_cluster(struct work_struct *work)
{
        struct decompress_io_ctx *dic =
                container_of(work, struct decompress_io_ctx, verity_work);
        int i;

        /* Verify, update, and unlock the decompressed pages. */
        for (i = 0; i < dic->cluster_size; i++) {
                struct page *rpage = dic->rpages[i];
                struct folio *rfolio;

                if (!rpage)
                        continue;
                rfolio = page_folio(rpage);
                if (fsverity_verify_folio(dic->vi, rfolio))
                        folio_mark_uptodate(rfolio);
                folio_unlock(rfolio);
        }

        f2fs_put_dic(dic, true);
}

/*
 * This is called when a compressed cluster has been decompressed
 * (or failed to be read and/or decompressed).
 */
void f2fs_decompress_end_io(struct decompress_io_ctx *dic, bool failed,
                                bool in_task)
{
        int i;

        if (IS_ENABLED(CONFIG_FS_VERITY) && !failed && dic->vi) {
                /*
                 * Note that to avoid deadlocks, the verity work can't be done
                 * on the decompression workqueue.  This is because verifying
                 * the data pages can involve reading metadata pages from the
                 * file, and these metadata pages may be compressed.
                 */
                INIT_WORK(&dic->verity_work, f2fs_verify_cluster);
                fsverity_enqueue_verify_work(&dic->verity_work);
                return;
        }

        /* Update and unlock the cluster's pagecache pages. */
        for (i = 0; i < dic->cluster_size; i++) {
                struct page *rpage = dic->rpages[i];

                if (!rpage)
                        continue;

                if (failed)
                        ClearPageUptodate(rpage);
                else
                        SetPageUptodate(rpage);
                unlock_page(rpage);
        }

        /*
         * Release the reference to the decompress_io_ctx that was being held
         * for I/O completion.
         */
        f2fs_put_dic(dic, in_task);
}

/*
 * Put a reference to a compressed folio's decompress_io_ctx.
 *
 * This is called when the folio is no longer needed and can be freed.
 */
void f2fs_put_folio_dic(struct folio *folio, bool in_task)
{
        struct decompress_io_ctx *dic = folio->private;

        f2fs_put_dic(dic, in_task);
}

/*
 * check whether cluster blocks are contiguous, and add extent cache entry
 * only if cluster blocks are logically and physically contiguous.
 */
unsigned int f2fs_cluster_blocks_are_contiguous(struct dnode_of_data *dn,
                                                unsigned int ofs_in_node)
{
        bool compressed = data_blkaddr(dn->inode, dn->node_folio,
                                        ofs_in_node) == COMPRESS_ADDR;
        int i = compressed ? 1 : 0;
        block_t first_blkaddr = data_blkaddr(dn->inode, dn->node_folio,
                                                        ofs_in_node + i);

        for (i += 1; i < F2FS_I(dn->inode)->i_cluster_size; i++) {
                block_t blkaddr = data_blkaddr(dn->inode, dn->node_folio,
                                                        ofs_in_node + i);

                if (!__is_valid_data_blkaddr(blkaddr))
                        break;
                if (first_blkaddr + i - (compressed ? 1 : 0) != blkaddr)
                        return 0;
        }

        return compressed ? i - 1 : i;
}

const struct address_space_operations f2fs_compress_aops = {
        .release_folio = f2fs_release_folio,
        .invalidate_folio = f2fs_invalidate_folio,
        .migrate_folio        = filemap_migrate_folio,
};

struct address_space *COMPRESS_MAPPING(struct f2fs_sb_info *sbi)
{
        return sbi->compress_inode->i_mapping;
}

void f2fs_invalidate_compress_pages_range(struct f2fs_sb_info *sbi,
                                block_t blkaddr, unsigned int len)
{
        if (!sbi->compress_inode)
                return;
        invalidate_mapping_pages(COMPRESS_MAPPING(sbi), blkaddr, blkaddr + len - 1);
}

static void f2fs_cache_compressed_page(struct f2fs_sb_info *sbi,
                struct folio *folio, nid_t ino, block_t blkaddr)
{
        struct folio *cfolio;
        int ret;

        if (!test_opt(sbi, COMPRESS_CACHE))
                return;

        if (!f2fs_is_valid_blkaddr(sbi, blkaddr, DATA_GENERIC_ENHANCE_READ))
                return;

        if (!f2fs_available_free_memory(sbi, COMPRESS_PAGE))
                return;

        cfolio = filemap_get_folio(COMPRESS_MAPPING(sbi), blkaddr);
        if (!IS_ERR(cfolio)) {
                f2fs_folio_put(cfolio, false);
                return;
        }

        cfolio = filemap_alloc_folio(__GFP_NOWARN | __GFP_IO, 0, NULL);
        if (!cfolio)
                return;

        ret = filemap_add_folio(COMPRESS_MAPPING(sbi), cfolio,
                                                blkaddr, GFP_NOFS);
        if (ret) {
                f2fs_folio_put(cfolio, false);
                return;
        }

        folio_set_f2fs_data(cfolio, ino);

        memcpy(folio_address(cfolio), folio_address(folio), PAGE_SIZE);
        folio_mark_uptodate(cfolio);
        f2fs_folio_put(cfolio, true);
}

bool f2fs_load_compressed_folio(struct f2fs_sb_info *sbi, struct folio *folio,
                                                                block_t blkaddr)
{
        struct folio *cfolio;
        bool hitted = false;

        if (!test_opt(sbi, COMPRESS_CACHE))
                return false;

        cfolio = f2fs_filemap_get_folio(COMPRESS_MAPPING(sbi),
                                blkaddr, FGP_LOCK | FGP_NOWAIT, GFP_NOFS);
        if (!IS_ERR(cfolio)) {
                if (folio_test_uptodate(cfolio)) {
                        atomic_inc(&sbi->compress_page_hit);
                        memcpy(folio_address(folio),
                                folio_address(cfolio), folio_size(folio));
                        hitted = true;
                }
                f2fs_folio_put(cfolio, true);
        }

        return hitted;
}

void f2fs_invalidate_compress_pages(struct f2fs_sb_info *sbi, nid_t ino)
{
        struct address_space *mapping = COMPRESS_MAPPING(sbi);
        struct folio_batch fbatch;
        pgoff_t index = 0;
        pgoff_t end = MAX_BLKADDR(sbi);

        if (!mapping->nrpages)
                return;

        folio_batch_init(&fbatch);

        do {
                unsigned int nr, i;

                nr = filemap_get_folios(mapping, &index, end - 1, &fbatch);
                if (!nr)
                        break;

                for (i = 0; i < nr; i++) {
                        struct folio *folio = fbatch.folios[i];

                        folio_lock(folio);
                        if (folio->mapping != mapping) {
                                folio_unlock(folio);
                                continue;
                        }

                        if (ino != folio_get_f2fs_data(folio)) {
                                folio_unlock(folio);
                                continue;
                        }

                        generic_error_remove_folio(mapping, folio);
                        folio_unlock(folio);
                }
                folio_batch_release(&fbatch);
                cond_resched();
        } while (index < end);
}

int f2fs_init_compress_inode(struct f2fs_sb_info *sbi)
{
        struct inode *inode;

        if (!test_opt(sbi, COMPRESS_CACHE))
                return 0;

        inode = f2fs_iget(sbi->sb, F2FS_COMPRESS_INO(sbi));
        if (IS_ERR(inode))
                return PTR_ERR(inode);
        sbi->compress_inode = inode;

        sbi->compress_percent = COMPRESS_PERCENT;
        sbi->compress_watermark = COMPRESS_WATERMARK;

        atomic_set(&sbi->compress_page_hit, 0);

        return 0;
}

void f2fs_destroy_compress_inode(struct f2fs_sb_info *sbi)
{
        if (!sbi->compress_inode)
                return;
        iput(sbi->compress_inode);
        sbi->compress_inode = NULL;
}

int f2fs_init_page_array_cache(struct f2fs_sb_info *sbi)
{
        dev_t dev = sbi->sb->s_bdev->bd_dev;
        char slab_name[35];

        if (!f2fs_sb_has_compression(sbi))
                return 0;

        sprintf(slab_name, "f2fs_page_array_entry-%u:%u", MAJOR(dev), MINOR(dev));

        sbi->page_array_slab_size = sizeof(struct page *) <<
                                        F2FS_OPTION(sbi).compress_log_size;

        sbi->page_array_slab = f2fs_kmem_cache_create(slab_name,
                                        sbi->page_array_slab_size);
        return sbi->page_array_slab ? 0 : -ENOMEM;
}

void f2fs_destroy_page_array_cache(struct f2fs_sb_info *sbi)
{
        kmem_cache_destroy(sbi->page_array_slab);
}

int __init f2fs_init_compress_cache(void)
{
        cic_entry_slab = f2fs_kmem_cache_create("f2fs_cic_entry",
                                        sizeof(struct compress_io_ctx));
        if (!cic_entry_slab)
                return -ENOMEM;
        dic_entry_slab = f2fs_kmem_cache_create("f2fs_dic_entry",
                                        sizeof(struct decompress_io_ctx));
        if (!dic_entry_slab)
                goto free_cic;
        return 0;
free_cic:
        kmem_cache_destroy(cic_entry_slab);
        return -ENOMEM;
}

void f2fs_destroy_compress_cache(void)
{
        kmem_cache_destroy(dic_entry_slab);
        kmem_cache_destroy(cic_entry_slab);
}





















































































































































































   73 





   73 







   45 



   45 









   67 

   67 








   67 





   67 
   67 




   65 



   67 










   66 
   67 


   67 













    3 
























    3 



















   66 



   66 




















   66 
   64 







   66 





   60 
















   43 






   66 





   60 









   43 


   66 




   60 





   63 










   62 















   55 








   55 













    5 




    5 
    5 











    8 








    8 
















    5 
    5 
    5 


    8 



































































































   82 













    5 




















   66 
   66 
   67 











   67 























   66 



   67 

























































































































































































































   67 


   68 
   68 









   68 






   67 
















































   71 









   71 
   71 




























   61 


















   55 


   55 


   56 


   56 


   56 




   56 







   15 




    4 










    2 
    2 
    2 


   15 







   15 











































   54 




   54 

   55 
   54 
















   10 





   10 





   10 






   43 
   42 




   42 
   43 







   65 




   64 









   43 
   43 




   43 









   65 






   72 






   72 


   71 


   65 

   12 
   10 



   72 

   71 














   67 





    9 
   10 




   10 




    9 

    9 

    9 
   10 
    9 













    4 















    2 

    2 








    2 

    2 





    2 

    2 
















    8 













    8 


    8 





    8 

    8 






    8 


    8 
















    8 



























































































    3 






    3 
    3 






    3 



    3 





    3 

    3 

















    3 














































































    4 











    4 





    4 


    4 


    4 












    4 





    4 

    4 




    4 

    3 

    4 


    1 












    4 


























    6 





    3 















   10 













   10 


   10 


    9 


    1 








    8 

    1 

    7 


    8 

    8 
    8 
    8 

    1 

    1 





    8 


    7 











    7 




   10 

    7 



    1 




    6 






    7 
    2 
    1 




    6 



    4 


    3 


    2 

    1 




















    3 

    3 







    3 





































































































































































































    5 







    5 

    4 


    4 



    3 





    2 







    2 







    2 








    2 

















    2 





    2 


    2 

    2 



































































   43 
















   41 



   42 




















    5 





























   68 





   47 










   61 



   61 









   68 


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
/*
 * drm_irq.c IRQ and vblank support
 *
 * \author Rickard E. (Rik) Faith <faith@valinux.com>
 * \author Gareth Hughes <gareth@valinux.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#include <linux/export.h>
#include <linux/kthread.h>
#include <linux/moduleparam.h>

#include <drm/drm_crtc.h>
#include <drm/drm_drv.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_managed.h>
#include <drm/drm_modeset_helper_vtables.h>
#include <drm/drm_print.h>
#include <drm/drm_vblank.h>

#include "drm_internal.h"
#include "drm_trace.h"

/**
 * DOC: vblank handling
 *
 * From the computer's perspective, every time the monitor displays
 * a new frame the scanout engine has "scanned out" the display image
 * from top to bottom, one row of pixels at a time. The current row
 * of pixels is referred to as the current scanline.
 *
 * In addition to the display's visible area, there's usually a couple of
 * extra scanlines which aren't actually displayed on the screen.
 * These extra scanlines don't contain image data and are occasionally used
 * for features like audio and infoframes. The region made up of these
 * scanlines is referred to as the vertical blanking region, or vblank for
 * short.
 *
 * For historical reference, the vertical blanking period was designed to
 * give the electron gun (on CRTs) enough time to move back to the top of
 * the screen to start scanning out the next frame. Similar for horizontal
 * blanking periods. They were designed to give the electron gun enough
 * time to move back to the other side of the screen to start scanning the
 * next scanline.
 *
 * ::
 *
 *
 *    physical →   ⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽
 *    top of      |                                        |
 *    display     |                                        |
 *                |               New frame                |
 *                |                                        |
 *                |↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓|
 *                |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| ← Scanline,
 *                |↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓|   updates the
 *                |                                        |   frame as it
 *                |                                        |   travels down
 *                |                                        |   ("scan out")
 *                |               Old frame                |
 *                |                                        |
 *                |                                        |
 *                |                                        |
 *                |                                        |   physical
 *                |                                        |   bottom of
 *    vertical    |⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽| ← display
 *    blanking    ┆xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx┆
 *    region   →  ┆xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx┆
 *                ┆xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx┆
 *    start of →   ⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽⎽
 *    new frame
 *
 * "Physical top of display" is the reference point for the high-precision/
 * corrected timestamp.
 *
 * On a lot of display hardware, programming needs to take effect during the
 * vertical blanking period so that settings like gamma, the image buffer
 * buffer to be scanned out, etc. can safely be changed without showing
 * any visual artifacts on the screen. In some unforgiving hardware, some of
 * this programming has to both start and end in the same vblank. To help
 * with the timing of the hardware programming, an interrupt is usually
 * available to notify the driver when it can start the updating of registers.
 * The interrupt is in this context named the vblank interrupt.
 *
 * The vblank interrupt may be fired at different points depending on the
 * hardware. Some hardware implementations will fire the interrupt when the
 * new frame start, other implementations will fire the interrupt at different
 * points in time.
 *
 * Vertical blanking plays a major role in graphics rendering. To achieve
 * tear-free display, users must synchronize page flips and/or rendering to
 * vertical blanking. The DRM API offers ioctls to perform page flips
 * synchronized to vertical blanking and wait for vertical blanking.
 *
 * The DRM core handles most of the vertical blanking management logic, which
 * involves filtering out spurious interrupts, keeping race-free blanking
 * counters, coping with counter wrap-around and resets and keeping use counts.
 * It relies on the driver to generate vertical blanking interrupts and
 * optionally provide a hardware vertical blanking counter.
 *
 * Drivers must initialize the vertical blanking handling core with a call to
 * drm_vblank_init(). Minimally, a driver needs to implement
 * &drm_crtc_funcs.enable_vblank and &drm_crtc_funcs.disable_vblank plus call
 * drm_crtc_handle_vblank() in its vblank interrupt handler for working vblank
 * support.
 *
 * Vertical blanking interrupts can be enabled by the DRM core or by drivers
 * themselves (for instance to handle page flipping operations).  The DRM core
 * maintains a vertical blanking use count to ensure that the interrupts are not
 * disabled while a user still needs them. To increment the use count, drivers
 * call drm_crtc_vblank_get() and release the vblank reference again with
 * drm_crtc_vblank_put(). In between these two calls vblank interrupts are
 * guaranteed to be enabled.
 *
 * On many hardware disabling the vblank interrupt cannot be done in a race-free
 * manner, see &drm_vblank_crtc_config.disable_immediate and
 * &drm_driver.max_vblank_count. In that case the vblank core only disables the
 * vblanks after a timer has expired, which can be configured through the
 * ``vblankoffdelay`` module parameter.
 *
 * Drivers for hardware without support for vertical-blanking interrupts can
 * use DRM vblank timers to send vblank events at the rate of the current
 * display mode's refresh. While not synchronized to the hardware's
 * vertical-blanking regions, the timer helps DRM clients and compositors to
 * adapt their update cycle to the display output. Drivers should set up
 * vblanking as usual, but call drm_crtc_vblank_start_timer() and
 * drm_crtc_vblank_cancel_timer() as part of their atomic mode setting.
 * See also DRM vblank helpers for more information.
 *
 * Drivers without support for vertical-blanking interrupts nor timers must
 * not call drm_vblank_init(). For these drivers, atomic helpers will
 * automatically generate fake vblank events as part of the display update.
 * This functionality also can be controlled by the driver by enabling and
 * disabling struct drm_crtc_state.no_vblank.
 */

/* Retry timestamp calculation up to 3 times to satisfy
 * drm_timestamp_precision before giving up.
 */
#define DRM_TIMESTAMP_MAXRETRIES 3

/* Threshold in nanoseconds for detection of redundant
 * vblank irq in drm_handle_vblank(). 1 msec should be ok.
 */
#define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000

static bool
drm_get_last_vbltimestamp(struct drm_device *dev, unsigned int pipe,
                          ktime_t *tvblank, bool in_vblank_irq);

static unsigned int drm_timestamp_precision = 20;  /* Default to 20 usecs. */

static int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */

module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
MODULE_PARM_DESC(vblankoffdelay, "Delay until vblank irq auto-disable [msecs] (0: never disable, <0: disable immediately)");
MODULE_PARM_DESC(timestamp_precision_usec, "Max. error on timestamps [usecs]");

static struct drm_vblank_crtc *
drm_vblank_crtc(struct drm_device *dev, unsigned int pipe)
{
        return &dev->vblank[pipe];
}

struct drm_vblank_crtc *
drm_crtc_vblank_crtc(struct drm_crtc *crtc)
{
        return drm_vblank_crtc(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_crtc);

static void store_vblank(struct drm_device *dev, unsigned int pipe,
                         u32 vblank_count_inc,
                         ktime_t t_vblank, u32 last)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);

        assert_spin_locked(&dev->vblank_time_lock);

        vblank->last = last;

        write_seqlock(&vblank->seqlock);
        vblank->time = t_vblank;
        atomic64_add(vblank_count_inc, &vblank->count);
        write_sequnlock(&vblank->seqlock);
}

static u32 drm_max_vblank_count(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);

        return vblank->max_vblank_count ?: dev->max_vblank_count;
}

/*
 * "No hw counter" fallback implementation of .get_vblank_counter() hook,
 * if there is no usable hardware frame counter available.
 */
static u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe)
{
        drm_WARN_ON_ONCE(dev, drm_max_vblank_count(dev, pipe) != 0);
        return 0;
}

static u32 __get_vblank_counter(struct drm_device *dev, unsigned int pipe)
{
        if (drm_core_check_feature(dev, DRIVER_MODESET)) {
                struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);

                if (drm_WARN_ON(dev, !crtc))
                        return 0;

                if (crtc->funcs->get_vblank_counter)
                        return crtc->funcs->get_vblank_counter(crtc);
        }

        return drm_vblank_no_hw_counter(dev, pipe);
}

static bool get_vblank_counter_and_timestamp(struct drm_device *dev, unsigned int pipe,
                                             u32 *cur_vblank, ktime_t *t_vblank,
                                             bool in_vblank_irq)
{
        int count = DRM_TIMESTAMP_MAXRETRIES;
        bool rc;

        do {
                *cur_vblank = __get_vblank_counter(dev, pipe);
                rc = drm_get_last_vbltimestamp(dev, pipe, t_vblank, in_vblank_irq);
        } while (*cur_vblank != __get_vblank_counter(dev, pipe) && --count > 0);

        return rc;
}

/*
 * Reset the stored timestamp for the current vblank count to correspond
 * to the last vblank occurred.
 *
 * Only to be called from drm_crtc_vblank_on().
 *
 * Note: caller must hold &drm_device.vbl_lock since this reads & writes
 * device vblank fields.
 */
static void drm_reset_vblank_timestamp(struct drm_device *dev, unsigned int pipe)
{
        u32 cur_vblank;
        bool rc;
        ktime_t t_vblank;

        spin_lock(&dev->vblank_time_lock);

        /*
         * sample the current counter to avoid random jumps
         * when drm_vblank_enable() applies the diff
         */
        rc = get_vblank_counter_and_timestamp(dev, pipe, &cur_vblank,
                                              &t_vblank, false);

        /*
         * Only reinitialize corresponding vblank timestamp if high-precision query
         * available and didn't fail. Otherwise reinitialize delayed at next vblank
         * interrupt and assign 0 for now, to mark the vblanktimestamp as invalid.
         */
        if (!rc)
                t_vblank = 0;

        /*
         * +1 to make sure user will never see the same
         * vblank counter value before and after a modeset
         */
        store_vblank(dev, pipe, 1, t_vblank, cur_vblank);

        spin_unlock(&dev->vblank_time_lock);
}

/*
 * Call back into the driver to update the appropriate vblank counter
 * (specified by @pipe).  Deal with wraparound, if it occurred, and
 * update the last read value so we can deal with wraparound on the next
 * call if necessary.
 *
 * Only necessary when going from off->on, to account for frames we
 * didn't get an interrupt for.
 *
 * Note: caller must hold &drm_device.vbl_lock since this reads & writes
 * device vblank fields.
 */
static void drm_update_vblank_count(struct drm_device *dev, unsigned int pipe,
                                    bool in_vblank_irq)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        u32 cur_vblank, diff;
        bool rc;
        ktime_t t_vblank;
        int framedur_ns = vblank->framedur_ns;
        u32 max_vblank_count = drm_max_vblank_count(dev, pipe);

        /*
         * Interrupts were disabled prior to this call, so deal with counter
         * wrap if needed.
         * NOTE!  It's possible we lost a full dev->max_vblank_count + 1 events
         * here if the register is small or we had vblank interrupts off for
         * a long time.
         *
         * We repeat the hardware vblank counter & timestamp query until
         * we get consistent results. This to prevent races between gpu
         * updating its hardware counter while we are retrieving the
         * corresponding vblank timestamp.
         */
        rc = get_vblank_counter_and_timestamp(dev, pipe, &cur_vblank,
                                              &t_vblank, in_vblank_irq);

        if (max_vblank_count) {
                /* trust the hw counter when it's around */
                diff = (cur_vblank - vblank->last) & max_vblank_count;
        } else if (rc && framedur_ns) {
                u64 diff_ns = ktime_to_ns(ktime_sub(t_vblank, vblank->time));

                /*
                 * Figure out how many vblanks we've missed based
                 * on the difference in the timestamps and the
                 * frame/field duration.
                 */

                drm_dbg_vbl(dev, "crtc %u: Calculating number of vblanks."
                            " diff_ns = %lld, framedur_ns = %d)\n",
                            pipe, (long long)diff_ns, framedur_ns);

                diff = DIV_ROUND_CLOSEST_ULL(diff_ns, framedur_ns);

                if (diff == 0 && in_vblank_irq)
                        drm_dbg_vbl(dev, "crtc %u: Redundant vblirq ignored\n",
                                    pipe);
        } else {
                /* some kind of default for drivers w/o accurate vbl timestamping */
                diff = in_vblank_irq ? 1 : 0;
        }

        /*
         * Within a drm_vblank_pre_modeset - drm_vblank_post_modeset
         * interval? If so then vblank irqs keep running and it will likely
         * happen that the hardware vblank counter is not trustworthy as it
         * might reset at some point in that interval and vblank timestamps
         * are not trustworthy either in that interval. Iow. this can result
         * in a bogus diff >> 1 which must be avoided as it would cause
         * random large forward jumps of the software vblank counter.
         */
        if (diff > 1 && (vblank->inmodeset & 0x2)) {
                drm_dbg_vbl(dev,
                            "clamping vblank bump to 1 on crtc %u: diffr=%u"
                            " due to pre-modeset.\n", pipe, diff);
                diff = 1;
        }

        drm_dbg_vbl(dev, "updating vblank count on crtc %u:"
                    " current=%llu, diff=%u, hw=%u hw_last=%u\n",
                    pipe, (unsigned long long)atomic64_read(&vblank->count),
                    diff, cur_vblank, vblank->last);

        if (diff == 0) {
                drm_WARN_ON_ONCE(dev, cur_vblank != vblank->last);
                return;
        }

        /*
         * Only reinitialize corresponding vblank timestamp if high-precision query
         * available and didn't fail, or we were called from the vblank interrupt.
         * Otherwise reinitialize delayed at next vblank interrupt and assign 0
         * for now, to mark the vblanktimestamp as invalid.
         */
        if (!rc && !in_vblank_irq)
                t_vblank = 0;

        store_vblank(dev, pipe, diff, t_vblank, cur_vblank);
}

u64 drm_vblank_count(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        u64 count;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return 0;

        count = atomic64_read(&vblank->count);

        /*
         * This read barrier corresponds to the implicit write barrier of the
         * write seqlock in store_vblank(). Note that this is the only place
         * where we need an explicit barrier, since all other access goes
         * through drm_vblank_count_and_time(), which already has the required
         * read barrier curtesy of the read seqlock.
         */
        smp_rmb();

        return count;
}

/**
 * drm_crtc_accurate_vblank_count - retrieve the master vblank counter
 * @crtc: which counter to retrieve
 *
 * This function is similar to drm_crtc_vblank_count() but this function
 * interpolates to handle a race with vblank interrupts using the high precision
 * timestamping support.
 *
 * This is mostly useful for hardware that can obtain the scanout position, but
 * doesn't have a hardware frame counter.
 */
u64 drm_crtc_accurate_vblank_count(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);
        u64 vblank;
        unsigned long flags;

        drm_WARN_ONCE(dev, drm_debug_enabled(DRM_UT_VBL) &&
                      !crtc->funcs->get_vblank_timestamp,
                      "This function requires support for accurate vblank timestamps.");

        spin_lock_irqsave(&dev->vblank_time_lock, flags);

        drm_update_vblank_count(dev, pipe, false);
        vblank = drm_vblank_count(dev, pipe);

        spin_unlock_irqrestore(&dev->vblank_time_lock, flags);

        return vblank;
}
EXPORT_SYMBOL(drm_crtc_accurate_vblank_count);

static void __disable_vblank(struct drm_device *dev, unsigned int pipe)
{
        if (drm_core_check_feature(dev, DRIVER_MODESET)) {
                struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);

                if (drm_WARN_ON(dev, !crtc))
                        return;

                if (crtc->funcs->disable_vblank)
                        crtc->funcs->disable_vblank(crtc);
        }
}

/*
 * Disable vblank irq's on crtc, make sure that last vblank count
 * of hardware and corresponding consistent software vblank counter
 * are preserved, even if there are any spurious vblank irq's after
 * disable.
 */
void drm_vblank_disable_and_save(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        unsigned long irqflags;

        assert_spin_locked(&dev->vbl_lock);

        /* Prevent vblank irq processing while disabling vblank irqs,
         * so no updates of timestamps or count can happen after we've
         * disabled. Needed to prevent races in case of delayed irq's.
         */
        spin_lock_irqsave(&dev->vblank_time_lock, irqflags);

        /*
         * Update vblank count and disable vblank interrupts only if the
         * interrupts were enabled. This avoids calling the ->disable_vblank()
         * operation in atomic context with the hardware potentially runtime
         * suspended.
         */
        if (!vblank->enabled)
                goto out;

        /*
         * Update the count and timestamp to maintain the
         * appearance that the counter has been ticking all along until
         * this time. This makes the count account for the entire time
         * between drm_crtc_vblank_on() and drm_crtc_vblank_off().
         */
        drm_update_vblank_count(dev, pipe, false);
        __disable_vblank(dev, pipe);
        vblank->enabled = false;

out:
        spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
}

static void vblank_disable_fn(struct timer_list *t)
{
        struct drm_vblank_crtc *vblank = timer_container_of(vblank, t,
                                                            disable_timer);
        struct drm_device *dev = vblank->dev;
        unsigned int pipe = vblank->pipe;
        unsigned long irqflags;

        spin_lock_irqsave(&dev->vbl_lock, irqflags);
        if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
                drm_dbg_core(dev, "disabling vblank on crtc %u\n", pipe);
                drm_vblank_disable_and_save(dev, pipe);
        }
        spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
}

static void drm_vblank_init_release(struct drm_device *dev, void *ptr)
{
        struct drm_vblank_crtc *vblank = ptr;

        drm_WARN_ON(dev, READ_ONCE(vblank->enabled) &&
                    drm_core_check_feature(dev, DRIVER_MODESET));

        if (vblank->vblank_timer.crtc)
                hrtimer_cancel(&vblank->vblank_timer.timer);

        drm_vblank_destroy_worker(vblank);
        timer_delete_sync(&vblank->disable_timer);
}

/**
 * drm_vblank_init - initialize vblank support
 * @dev: DRM device
 * @num_crtcs: number of CRTCs supported by @dev
 *
 * This function initializes vblank support for @num_crtcs display pipelines.
 * Cleanup is handled automatically through a cleanup function added with
 * drmm_add_action_or_reset().
 *
 * Returns:
 * Zero on success or a negative error code on failure.
 */
int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs)
{
        int ret;
        unsigned int i;

        spin_lock_init(&dev->vbl_lock);
        spin_lock_init(&dev->vblank_time_lock);

        dev->vblank = drmm_kcalloc(dev, num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
        if (!dev->vblank)
                return -ENOMEM;

        dev->num_crtcs = num_crtcs;

        for (i = 0; i < num_crtcs; i++) {
                struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, i);

                vblank->dev = dev;
                vblank->pipe = i;
                init_waitqueue_head(&vblank->queue);
                timer_setup(&vblank->disable_timer, vblank_disable_fn, 0);
                seqlock_init(&vblank->seqlock);

                ret = drmm_add_action_or_reset(dev, drm_vblank_init_release,
                                               vblank);
                if (ret)
                        return ret;

                ret = drm_vblank_worker_init(vblank);
                if (ret)
                        return ret;
        }

        return 0;
}
EXPORT_SYMBOL(drm_vblank_init);

/**
 * drm_dev_has_vblank - test if vblanking has been initialized for
 *                      a device
 * @dev: the device
 *
 * Drivers may call this function to test if vblank support is
 * initialized for a device. For most hardware this means that vblanking
 * can also be enabled.
 *
 * Atomic helpers use this function to initialize
 * &drm_crtc_state.no_vblank. See also drm_atomic_helper_check_modeset().
 *
 * Returns:
 * True if vblanking has been initialized for the given device, false
 * otherwise.
 */
bool drm_dev_has_vblank(const struct drm_device *dev)
{
        return dev->num_crtcs != 0;
}
EXPORT_SYMBOL(drm_dev_has_vblank);

/**
 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
 * @crtc: which CRTC's vblank waitqueue to retrieve
 *
 * This function returns a pointer to the vblank waitqueue for the CRTC.
 * Drivers can use this to implement vblank waits using wait_event() and related
 * functions.
 */
wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
{
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);

        return &vblank->queue;
}
EXPORT_SYMBOL(drm_crtc_vblank_waitqueue);


/**
 * drm_calc_timestamping_constants - calculate vblank timestamp constants
 * @crtc: drm_crtc whose timestamp constants should be updated.
 * @mode: display mode containing the scanout timings
 *
 * Calculate and store various constants which are later needed by vblank and
 * swap-completion timestamping, e.g, by
 * drm_crtc_vblank_helper_get_vblank_timestamp(). They are derived from
 * CRTC's true scanout timing, so they take things like panel scaling or
 * other adjustments into account.
 */
void drm_calc_timestamping_constants(struct drm_crtc *crtc,
                                     const struct drm_display_mode *mode)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        int linedur_ns = 0, framedur_ns = 0;
        int dotclock = mode->crtc_clock;

        if (!drm_dev_has_vblank(dev))
                return;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return;

        /* Valid dotclock? */
        if (dotclock > 0) {
                int frame_size = mode->crtc_htotal * mode->crtc_vtotal;

                /*
                 * Convert scanline length in pixels and video
                 * dot clock to line duration and frame duration
                 * in nanoseconds:
                 */
                linedur_ns  = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
                framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);

                /*
                 * Fields of interlaced scanout modes are only half a frame duration.
                 */
                if (mode->flags & DRM_MODE_FLAG_INTERLACE)
                        framedur_ns /= 2;
        } else {
                drm_err(dev, "crtc %u: Can't calculate constants, dotclock = 0!\n",
                        crtc->base.id);
        }

        vblank->linedur_ns  = linedur_ns;
        vblank->framedur_ns = framedur_ns;
        drm_mode_copy(&vblank->hwmode, mode);

        drm_dbg_core(dev,
                     "crtc %u: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
                     crtc->base.id, mode->crtc_htotal,
                     mode->crtc_vtotal, mode->crtc_vdisplay);
        drm_dbg_core(dev, "crtc %u: clock %d kHz framedur %d linedur %d\n",
                     crtc->base.id, dotclock, framedur_ns, linedur_ns);
}
EXPORT_SYMBOL(drm_calc_timestamping_constants);

/**
 * drm_crtc_vblank_helper_get_vblank_timestamp_internal - precise vblank
 *                                                        timestamp helper
 * @crtc: CRTC whose vblank timestamp to retrieve
 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
 *             On return contains true maximum error of timestamp
 * @vblank_time: Pointer to time which should receive the timestamp
 * @in_vblank_irq:
 *     True when called from drm_crtc_handle_vblank().  Some drivers
 *     need to apply some workarounds for gpu-specific vblank irq quirks
 *     if flag is set.
 * @get_scanout_position:
 *     Callback function to retrieve the scanout position. See
 *     @struct drm_crtc_helper_funcs.get_scanout_position.
 *
 * Implements calculation of exact vblank timestamps from given drm_display_mode
 * timings and current video scanout position of a CRTC.
 *
 * The current implementation only handles standard video modes. For double scan
 * and interlaced modes the driver is supposed to adjust the hardware mode
 * (taken from &drm_crtc_state.adjusted mode for atomic modeset drivers) to
 * match the scanout position reported.
 *
 * Note that atomic drivers must call drm_calc_timestamping_constants() before
 * enabling a CRTC. The atomic helpers already take care of that in
 * drm_atomic_helper_calc_timestamping_constants().
 *
 * Returns:
 * Returns true on success, and false on failure, i.e. when no accurate
 * timestamp could be acquired.
 */
bool
drm_crtc_vblank_helper_get_vblank_timestamp_internal(
        struct drm_crtc *crtc, int *max_error, ktime_t *vblank_time,
        bool in_vblank_irq,
        drm_vblank_get_scanout_position_func get_scanout_position)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = crtc->index;
        struct timespec64 ts_etime, ts_vblank_time;
        ktime_t stime, etime;
        bool vbl_status;
        const struct drm_display_mode *mode;
        int vpos, hpos, i;
        int delta_ns, duration_ns;

        if (pipe >= dev->num_crtcs) {
                drm_err(dev, "Invalid crtc %u\n", pipe);
                return false;
        }

        /* Scanout position query not supported? Should not happen. */
        if (!get_scanout_position) {
                drm_err(dev, "Called from CRTC w/o get_scanout_position()!?\n");
                return false;
        }

        if (drm_drv_uses_atomic_modeset(dev)) {
                struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);

                mode = &vblank->hwmode;
        } else {
                mode = &crtc->hwmode;
        }

        /* If mode timing undefined, just return as no-op:
         * Happens during initial modesetting of a crtc.
         */
        if (mode->crtc_clock == 0) {
                drm_dbg_core(dev, "crtc %u: Noop due to uninitialized mode.\n",
                             pipe);
                drm_WARN_ON_ONCE(dev, drm_drv_uses_atomic_modeset(dev));
                return false;
        }

        /* Get current scanout position with system timestamp.
         * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
         * if single query takes longer than max_error nanoseconds.
         *
         * This guarantees a tight bound on maximum error if
         * code gets preempted or delayed for some reason.
         */
        for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
                /*
                 * Get vertical and horizontal scanout position vpos, hpos,
                 * and bounding timestamps stime, etime, pre/post query.
                 */
                vbl_status = get_scanout_position(crtc, in_vblank_irq,
                                                  &vpos, &hpos,
                                                  &stime, &etime,
                                                  mode);

                /* Return as no-op if scanout query unsupported or failed. */
                if (!vbl_status) {
                        drm_dbg_core(dev,
                                     "crtc %u : scanoutpos query failed.\n",
                                     pipe);
                        return false;
                }

                /* Compute uncertainty in timestamp of scanout position query. */
                duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);

                /* Accept result with <  max_error nsecs timing uncertainty. */
                if (duration_ns <= *max_error)
                        break;
        }

        /* Noisy system timing? */
        if (i == DRM_TIMESTAMP_MAXRETRIES) {
                drm_dbg_core(dev,
                             "crtc %u: Noisy timestamp %d us > %d us [%d reps].\n",
                             pipe, duration_ns / 1000, *max_error / 1000, i);
        }

        /* Return upper bound of timestamp precision error. */
        *max_error = duration_ns;

        /* Convert scanout position into elapsed time at raw_time query
         * since start of scanout at first display scanline. delta_ns
         * can be negative if start of scanout hasn't happened yet.
         */
        delta_ns = div_s64(1000000LL * (vpos * mode->crtc_htotal + hpos),
                           mode->crtc_clock);

        /* Subtract time delta from raw timestamp to get final
         * vblank_time timestamp for end of vblank.
         */
        *vblank_time = ktime_sub_ns(etime, delta_ns);

        if (!drm_debug_enabled(DRM_UT_VBL))
                return true;

        ts_etime = ktime_to_timespec64(etime);
        ts_vblank_time = ktime_to_timespec64(*vblank_time);

        drm_dbg_vbl(dev,
                    "crtc %u : v p(%d,%d)@ %ptSp -> %ptSp [e %d us, %d rep]\n",
                    pipe, hpos, vpos, &ts_etime, &ts_vblank_time,
                    duration_ns / 1000, i);

        return true;
}
EXPORT_SYMBOL(drm_crtc_vblank_helper_get_vblank_timestamp_internal);

/**
 * drm_crtc_vblank_helper_get_vblank_timestamp - precise vblank timestamp
 *                                               helper
 * @crtc: CRTC whose vblank timestamp to retrieve
 * @max_error: Desired maximum allowable error in timestamps (nanosecs)
 *             On return contains true maximum error of timestamp
 * @vblank_time: Pointer to time which should receive the timestamp
 * @in_vblank_irq:
 *     True when called from drm_crtc_handle_vblank().  Some drivers
 *     need to apply some workarounds for gpu-specific vblank irq quirks
 *     if flag is set.
 *
 * Implements calculation of exact vblank timestamps from given drm_display_mode
 * timings and current video scanout position of a CRTC. This can be directly
 * used as the &drm_crtc_funcs.get_vblank_timestamp implementation of a kms
 * driver if &drm_crtc_helper_funcs.get_scanout_position is implemented.
 *
 * The current implementation only handles standard video modes. For double scan
 * and interlaced modes the driver is supposed to adjust the hardware mode
 * (taken from &drm_crtc_state.adjusted mode for atomic modeset drivers) to
 * match the scanout position reported.
 *
 * Note that atomic drivers must call drm_calc_timestamping_constants() before
 * enabling a CRTC. The atomic helpers already take care of that in
 * drm_atomic_helper_calc_timestamping_constants().
 *
 * Returns:
 * Returns true on success, and false on failure, i.e. when no accurate
 * timestamp could be acquired.
 */
bool drm_crtc_vblank_helper_get_vblank_timestamp(struct drm_crtc *crtc,
                                                 int *max_error,
                                                 ktime_t *vblank_time,
                                                 bool in_vblank_irq)
{
        return drm_crtc_vblank_helper_get_vblank_timestamp_internal(
                crtc, max_error, vblank_time, in_vblank_irq,
                crtc->helper_private->get_scanout_position);
}
EXPORT_SYMBOL(drm_crtc_vblank_helper_get_vblank_timestamp);

/**
 * drm_crtc_get_last_vbltimestamp - retrieve raw timestamp for the most
 *                                  recent vblank interval
 * @crtc: CRTC whose vblank timestamp to retrieve
 * @tvblank: Pointer to target time which should receive the timestamp
 * @in_vblank_irq:
 *     True when called from drm_crtc_handle_vblank().  Some drivers
 *     need to apply some workarounds for gpu-specific vblank irq quirks
 *     if flag is set.
 *
 * Fetches the system timestamp corresponding to the time of the most recent
 * vblank interval on specified CRTC. May call into kms-driver to
 * compute the timestamp with a high-precision GPU specific method.
 *
 * Returns zero if timestamp originates from uncorrected do_gettimeofday()
 * call, i.e., it isn't very precisely locked to the true vblank.
 *
 * Returns:
 * True if timestamp is considered to be very precise, false otherwise.
 */
static bool
drm_crtc_get_last_vbltimestamp(struct drm_crtc *crtc, ktime_t *tvblank,
                               bool in_vblank_irq)
{
        bool ret = false;

        /* Define requested maximum error on timestamps (nanoseconds). */
        int max_error = (int) drm_timestamp_precision * 1000;

        /* Query driver if possible and precision timestamping enabled. */
        if (crtc && crtc->funcs->get_vblank_timestamp && max_error > 0) {
                ret = crtc->funcs->get_vblank_timestamp(crtc, &max_error,
                                                        tvblank, in_vblank_irq);
        }

        /* GPU high precision timestamp query unsupported or failed.
         * Return current monotonic/gettimeofday timestamp as best estimate.
         */
        if (!ret)
                *tvblank = ktime_get();

        return ret;
}

static bool
drm_get_last_vbltimestamp(struct drm_device *dev, unsigned int pipe,
                          ktime_t *tvblank, bool in_vblank_irq)
{
        struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);

        return drm_crtc_get_last_vbltimestamp(crtc, tvblank, in_vblank_irq);
}

/**
 * drm_crtc_vblank_count - retrieve "cooked" vblank counter value
 * @crtc: which counter to retrieve
 *
 * Fetches the "cooked" vblank count value that represents the number of
 * vblank events since the system was booted, including lost events due to
 * modesetting activity. Note that this timer isn't correct against a racing
 * vblank interrupt (since it only reports the software vblank counter), see
 * drm_crtc_accurate_vblank_count() for such use-cases.
 *
 * Note that for a given vblank counter value drm_crtc_handle_vblank()
 * and drm_crtc_vblank_count() or drm_crtc_vblank_count_and_time()
 * provide a barrier: Any writes done before calling
 * drm_crtc_handle_vblank() will be visible to callers of the later
 * functions, if the vblank count is the same or a later one.
 *
 * See also &drm_vblank_crtc.count.
 *
 * Returns:
 * The software vblank counter.
 */
u64 drm_crtc_vblank_count(struct drm_crtc *crtc)
{
        return drm_vblank_count(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_count);

/**
 * drm_vblank_count_and_time - retrieve "cooked" vblank counter value and the
 *     system timestamp corresponding to that vblank counter value.
 * @dev: DRM device
 * @pipe: index of CRTC whose counter to retrieve
 * @vblanktime: Pointer to ktime_t to receive the vblank timestamp.
 *
 * Fetches the "cooked" vblank count value that represents the number of
 * vblank events since the system was booted, including lost events due to
 * modesetting activity. Returns corresponding system timestamp of the time
 * of the vblank interval that corresponds to the current vblank counter value.
 *
 * This is the legacy version of drm_crtc_vblank_count_and_time().
 */
static u64 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
                                     ktime_t *vblanktime)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        u64 vblank_count;
        unsigned int seq;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs)) {
                *vblanktime = 0;
                return 0;
        }

        do {
                seq = read_seqbegin(&vblank->seqlock);
                vblank_count = atomic64_read(&vblank->count);
                *vblanktime = vblank->time;
        } while (read_seqretry(&vblank->seqlock, seq));

        return vblank_count;
}

/**
 * drm_crtc_vblank_count_and_time - retrieve "cooked" vblank counter value
 *     and the system timestamp corresponding to that vblank counter value
 * @crtc: which counter to retrieve
 * @vblanktime: Pointer to time to receive the vblank timestamp.
 *
 * Fetches the "cooked" vblank count value that represents the number of
 * vblank events since the system was booted, including lost events due to
 * modesetting activity. Returns corresponding system timestamp of the time
 * of the vblank interval that corresponds to the current vblank counter value.
 *
 * Note that for a given vblank counter value drm_crtc_handle_vblank()
 * and drm_crtc_vblank_count() or drm_crtc_vblank_count_and_time()
 * provide a barrier: Any writes done before calling
 * drm_crtc_handle_vblank() will be visible to callers of the later
 * functions, if the vblank count is the same or a later one.
 *
 * See also &drm_vblank_crtc.count.
 */
u64 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
                                   ktime_t *vblanktime)
{
        return drm_vblank_count_and_time(crtc->dev, drm_crtc_index(crtc),
                                         vblanktime);
}
EXPORT_SYMBOL(drm_crtc_vblank_count_and_time);

/**
 * drm_crtc_next_vblank_start - calculate the time of the next vblank
 * @crtc: the crtc for which to calculate next vblank time
 * @vblanktime: pointer to time to receive the next vblank timestamp.
 *
 * Calculate the expected time of the start of the next vblank period,
 * based on time of previous vblank and frame duration
 */
int drm_crtc_next_vblank_start(struct drm_crtc *crtc, ktime_t *vblanktime)
{
        struct drm_vblank_crtc *vblank;
        struct drm_display_mode *mode;
        u64 vblank_start;

        if (!drm_dev_has_vblank(crtc->dev))
                return -EINVAL;

        vblank = drm_crtc_vblank_crtc(crtc);
        mode = &vblank->hwmode;

        if (!vblank->framedur_ns || !vblank->linedur_ns)
                return -EINVAL;

        if (!drm_crtc_get_last_vbltimestamp(crtc, vblanktime, false))
                return -EINVAL;

        vblank_start = DIV_ROUND_DOWN_ULL(
                        (u64)vblank->framedur_ns * mode->crtc_vblank_start,
                        mode->crtc_vtotal);
        *vblanktime  = ktime_add(*vblanktime, ns_to_ktime(vblank_start));

        return 0;
}
EXPORT_SYMBOL(drm_crtc_next_vblank_start);

static void send_vblank_event(struct drm_device *dev,
                struct drm_pending_vblank_event *e,
                u64 seq, ktime_t now)
{
        struct timespec64 tv;

        switch (e->event.base.type) {
        case DRM_EVENT_VBLANK:
        case DRM_EVENT_FLIP_COMPLETE:
                tv = ktime_to_timespec64(now);
                e->event.vbl.sequence = seq;
                /*
                 * e->event is a user space structure, with hardcoded unsigned
                 * 32-bit seconds/microseconds. This is safe as we always use
                 * monotonic timestamps since linux-4.15
                 */
                e->event.vbl.tv_sec = tv.tv_sec;
                e->event.vbl.tv_usec = tv.tv_nsec / 1000;
                break;
        case DRM_EVENT_CRTC_SEQUENCE:
                if (seq)
                        e->event.seq.sequence = seq;
                e->event.seq.time_ns = ktime_to_ns(now);
                break;
        }
        trace_drm_vblank_event_delivered(e->base.file_priv, e->pipe, seq);
        /*
         * Use the same timestamp for any associated fence signal to avoid
         * mismatch in timestamps for vsync & fence events triggered by the
         * same HW event. Frameworks like SurfaceFlinger in Android expects the
         * retire-fence timestamp to match exactly with HW vsync as it uses it
         * for its software vsync modeling.
         */
        drm_send_event_timestamp_locked(dev, &e->base, now);
}

/**
 * drm_crtc_arm_vblank_event - arm vblank event after pageflip
 * @crtc: the source CRTC of the vblank event
 * @e: the event to send
 *
 * A lot of drivers need to generate vblank events for the very next vblank
 * interrupt. For example when the page flip interrupt happens when the page
 * flip gets armed, but not when it actually executes within the next vblank
 * period. This helper function implements exactly the required vblank arming
 * behaviour.
 *
 * NOTE: Drivers using this to send out the &drm_crtc_state.event as part of an
 * atomic commit must ensure that the next vblank happens at exactly the same
 * time as the atomic commit is committed to the hardware. This function itself
 * does **not** protect against the next vblank interrupt racing with either this
 * function call or the atomic commit operation. A possible sequence could be:
 *
 * 1. Driver commits new hardware state into vblank-synchronized registers.
 * 2. A vblank happens, committing the hardware state. Also the corresponding
 *    vblank interrupt is fired off and fully processed by the interrupt
 *    handler.
 * 3. The atomic commit operation proceeds to call drm_crtc_arm_vblank_event().
 * 4. The event is only send out for the next vblank, which is wrong.
 *
 * An equivalent race can happen when the driver calls
 * drm_crtc_arm_vblank_event() before writing out the new hardware state.
 *
 * The only way to make this work safely is to prevent the vblank from firing
 * (and the hardware from committing anything else) until the entire atomic
 * commit sequence has run to completion. If the hardware does not have such a
 * feature (e.g. using a "go" bit), then it is unsafe to use this functions.
 * Instead drivers need to manually send out the event from their interrupt
 * handler by calling drm_crtc_send_vblank_event() and make sure that there's no
 * possible race with the hardware committing the atomic update.
 *
 * Caller must hold a vblank reference for the event @e acquired by a
 * drm_crtc_vblank_get(), which will be dropped when the next vblank arrives.
 */
void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
                               struct drm_pending_vblank_event *e)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);

        assert_spin_locked(&dev->event_lock);

        e->pipe = pipe;
        e->sequence = drm_crtc_accurate_vblank_count(crtc) + 1;
        list_add_tail(&e->base.link, &dev->vblank_event_list);
}
EXPORT_SYMBOL(drm_crtc_arm_vblank_event);

/**
 * drm_crtc_send_vblank_event - helper to send vblank event after pageflip
 * @crtc: the source CRTC of the vblank event
 * @e: the event to send
 *
 * Updates sequence # and timestamp on event for the most recently processed
 * vblank, and sends it to userspace.  Caller must hold event lock.
 *
 * See drm_crtc_arm_vblank_event() for a helper which can be used in certain
 * situation, especially to send out events for atomic commit operations.
 */
void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
                                struct drm_pending_vblank_event *e)
{
        struct drm_device *dev = crtc->dev;
        u64 seq;
        unsigned int pipe = drm_crtc_index(crtc);
        ktime_t now;

        if (drm_dev_has_vblank(dev)) {
                seq = drm_vblank_count_and_time(dev, pipe, &now);
        } else {
                seq = 0;

                now = ktime_get();
        }
        e->pipe = pipe;
        send_vblank_event(dev, e, seq, now);
}
EXPORT_SYMBOL(drm_crtc_send_vblank_event);

static int __enable_vblank(struct drm_device *dev, unsigned int pipe)
{
        if (drm_core_check_feature(dev, DRIVER_MODESET)) {
                struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);

                if (drm_WARN_ON(dev, !crtc))
                        return 0;

                if (crtc->funcs->enable_vblank)
                        return crtc->funcs->enable_vblank(crtc);
        }

        return -EINVAL;
}

static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        int ret = 0;

        assert_spin_locked(&dev->vbl_lock);

        spin_lock(&dev->vblank_time_lock);

        if (!vblank->enabled) {
                /*
                 * Enable vblank irqs under vblank_time_lock protection.
                 * All vblank count & timestamp updates are held off
                 * until we are done reinitializing master counter and
                 * timestamps. Filtercode in drm_handle_vblank() will
                 * prevent double-accounting of same vblank interval.
                 */
                ret = __enable_vblank(dev, pipe);
                drm_dbg_core(dev, "enabling vblank on crtc %u, ret: %d\n",
                             pipe, ret);
                if (ret) {
                        atomic_dec(&vblank->refcount);
                } else {
                        drm_update_vblank_count(dev, pipe, 0);
                        /* drm_update_vblank_count() includes a wmb so we just
                         * need to ensure that the compiler emits the write
                         * to mark the vblank as enabled after the call
                         * to drm_update_vblank_count().
                         */
                        WRITE_ONCE(vblank->enabled, true);
                }
        }

        spin_unlock(&dev->vblank_time_lock);

        return ret;
}

int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        unsigned long irqflags;
        int ret = 0;

        if (!drm_dev_has_vblank(dev))
                return -EINVAL;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return -EINVAL;

        spin_lock_irqsave(&dev->vbl_lock, irqflags);
        /* Going from 0->1 means we have to enable interrupts again */
        if (atomic_add_return(1, &vblank->refcount) == 1) {
                ret = drm_vblank_enable(dev, pipe);
        } else {
                if (!vblank->enabled) {
                        atomic_dec(&vblank->refcount);
                        ret = -EINVAL;
                }
        }
        spin_unlock_irqrestore(&dev->vbl_lock, irqflags);

        return ret;
}

/**
 * drm_crtc_vblank_get - get a reference count on vblank events
 * @crtc: which CRTC to own
 *
 * Acquire a reference count on vblank events to avoid having them disabled
 * while in use.
 *
 * Returns:
 * Zero on success or a negative error code on failure.
 */
int drm_crtc_vblank_get(struct drm_crtc *crtc)
{
        return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_get);

void drm_vblank_put(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        int vblank_offdelay = vblank->config.offdelay_ms;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return;

        if (drm_WARN_ON(dev, atomic_read(&vblank->refcount) == 0))
                return;

        /* Last user schedules interrupt disable */
        if (atomic_dec_and_test(&vblank->refcount)) {
                if (!vblank_offdelay)
                        return;
                else if (vblank_offdelay < 0)
                        vblank_disable_fn(&vblank->disable_timer);
                else if (!vblank->config.disable_immediate)
                        mod_timer(&vblank->disable_timer,
                                  jiffies + ((vblank_offdelay * HZ) / 1000));
        }
}

/**
 * drm_crtc_vblank_put - give up ownership of vblank events
 * @crtc: which counter to give up
 *
 * Release ownership of a given vblank counter, turning off interrupts
 * if possible. Disable interrupts after &drm_vblank_crtc_config.offdelay_ms
 * milliseconds.
 */
void drm_crtc_vblank_put(struct drm_crtc *crtc)
{
        drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_vblank_put);

/**
 * drm_crtc_wait_one_vblank - wait for one vblank
 * @crtc: DRM crtc
 *
 * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
 * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
 * due to lack of driver support or because the crtc is off.
 *
 * Returns: 0 on success, negative error on failures.
 */
int drm_crtc_wait_one_vblank(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;
        int pipe = drm_crtc_index(crtc);
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        int ret;
        u64 last;

        ret = drm_vblank_get(dev, pipe);
        if (drm_WARN(dev, ret, "vblank not available on crtc %i, ret=%i\n",
                     pipe, ret))
                return ret;

        last = drm_vblank_count(dev, pipe);

        ret = wait_event_timeout(vblank->queue,
                                 last != drm_vblank_count(dev, pipe),
                                 msecs_to_jiffies(1000));

        drm_WARN(dev, ret == 0, "vblank wait timed out on crtc %i\n", pipe);

        drm_vblank_put(dev, pipe);

        return ret ? 0 : -ETIMEDOUT;
}
EXPORT_SYMBOL(drm_crtc_wait_one_vblank);

/**
 * drm_crtc_vblank_off - disable vblank events on a CRTC
 * @crtc: CRTC in question
 *
 * Drivers can use this function to shut down the vblank interrupt handling when
 * disabling a crtc. This function ensures that the latest vblank frame count is
 * stored so that drm_vblank_on can restore it again.
 *
 * Drivers must use this function when the hardware vblank counter can get
 * reset, e.g. when suspending or disabling the @crtc in general.
 */
void drm_crtc_vblank_off(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        struct drm_pending_vblank_event *e, *t;
        ktime_t now;
        u64 seq;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return;

        /*
         * Grab event_lock early to prevent vblank work from being scheduled
         * while we're in the middle of shutting down vblank interrupts
         */
        spin_lock_irq(&dev->event_lock);

        spin_lock(&dev->vbl_lock);
        drm_dbg_vbl(dev, "crtc %d, vblank enabled %d, inmodeset %d\n",
                    pipe, vblank->enabled, vblank->inmodeset);

        /* Avoid redundant vblank disables without previous
         * drm_crtc_vblank_on(). */
        if (drm_core_check_feature(dev, DRIVER_ATOMIC) || !vblank->inmodeset)
                drm_vblank_disable_and_save(dev, pipe);

        wake_up(&vblank->queue);

        /*
         * Prevent subsequent drm_vblank_get() from re-enabling
         * the vblank interrupt by bumping the refcount.
         */
        if (!vblank->inmodeset) {
                atomic_inc(&vblank->refcount);
                vblank->inmodeset = 1;
        }
        spin_unlock(&dev->vbl_lock);

        /* Send any queued vblank events, lest the natives grow disquiet */
        seq = drm_vblank_count_and_time(dev, pipe, &now);

        list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
                if (e->pipe != pipe)
                        continue;
                drm_dbg_core(dev, "Sending premature vblank event on disable: "
                             "wanted %llu, current %llu\n",
                             e->sequence, seq);
                list_del(&e->base.link);
                drm_vblank_put(dev, pipe);
                send_vblank_event(dev, e, seq, now);
        }

        /* Cancel any leftover pending vblank work */
        drm_vblank_cancel_pending_works(vblank);

        spin_unlock_irq(&dev->event_lock);

        /* Will be reset by the modeset helpers when re-enabling the crtc by
         * calling drm_calc_timestamping_constants(). */
        vblank->hwmode.crtc_clock = 0;

        /* Wait for any vblank work that's still executing to finish */
        drm_vblank_flush_worker(vblank);
}
EXPORT_SYMBOL(drm_crtc_vblank_off);

/**
 * drm_crtc_vblank_reset - reset vblank state to off on a CRTC
 * @crtc: CRTC in question
 *
 * Drivers can use this function to reset the vblank state to off at load time.
 * Drivers should use this together with the drm_crtc_vblank_off() and
 * drm_crtc_vblank_on() functions. The difference compared to
 * drm_crtc_vblank_off() is that this function doesn't save the vblank counter
 * and hence doesn't need to call any driver hooks.
 *
 * This is useful for recovering driver state e.g. on driver load, or on resume.
 */
void drm_crtc_vblank_reset(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);

        spin_lock_irq(&dev->vbl_lock);
        /*
         * Prevent subsequent drm_vblank_get() from enabling the vblank
         * interrupt by bumping the refcount.
         */
        if (!vblank->inmodeset) {
                atomic_inc(&vblank->refcount);
                vblank->inmodeset = 1;
        }
        spin_unlock_irq(&dev->vbl_lock);

        drm_WARN_ON(dev, !list_empty(&dev->vblank_event_list));
        drm_WARN_ON(dev, !list_empty(&vblank->pending_work));
}
EXPORT_SYMBOL(drm_crtc_vblank_reset);

/**
 * drm_crtc_set_max_vblank_count - configure the hw max vblank counter value
 * @crtc: CRTC in question
 * @max_vblank_count: max hardware vblank counter value
 *
 * Update the maximum hardware vblank counter value for @crtc
 * at runtime. Useful for hardware where the operation of the
 * hardware vblank counter depends on the currently active
 * display configuration.
 *
 * For example, if the hardware vblank counter does not work
 * when a specific connector is active the maximum can be set
 * to zero. And when that specific connector isn't active the
 * maximum can again be set to the appropriate non-zero value.
 *
 * If used, must be called before drm_vblank_on().
 */
void drm_crtc_set_max_vblank_count(struct drm_crtc *crtc,
                                   u32 max_vblank_count)
{
        struct drm_device *dev = crtc->dev;
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);

        drm_WARN_ON(dev, dev->max_vblank_count);
        drm_WARN_ON(dev, !READ_ONCE(vblank->inmodeset));

        vblank->max_vblank_count = max_vblank_count;
}
EXPORT_SYMBOL(drm_crtc_set_max_vblank_count);

/**
 * drm_crtc_vblank_on_config - enable vblank events on a CRTC with custom
 *     configuration options
 * @crtc: CRTC in question
 * @config: Vblank configuration value
 *
 * See drm_crtc_vblank_on(). In addition, this function allows you to provide a
 * custom vblank configuration for a given CRTC.
 *
 * Note that @config is copied, the pointer does not need to stay valid beyond
 * this function call. For details of the parameters see
 * struct drm_vblank_crtc_config.
 */
void drm_crtc_vblank_on_config(struct drm_crtc *crtc,
                               const struct drm_vblank_crtc_config *config)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return;

        spin_lock_irq(&dev->vbl_lock);
        drm_dbg_vbl(dev, "crtc %d, vblank enabled %d, inmodeset %d\n",
                    pipe, vblank->enabled, vblank->inmodeset);

        vblank->config = *config;

        /* Drop our private "prevent drm_vblank_get" refcount */
        if (vblank->inmodeset) {
                atomic_dec(&vblank->refcount);
                vblank->inmodeset = 0;
        }

        drm_reset_vblank_timestamp(dev, pipe);

        /*
         * re-enable interrupts if there are users left, or the
         * user wishes vblank interrupts to be enabled all the time.
         */
        if (atomic_read(&vblank->refcount) != 0 || !vblank->config.offdelay_ms)
                drm_WARN_ON(dev, drm_vblank_enable(dev, pipe));
        spin_unlock_irq(&dev->vbl_lock);
}
EXPORT_SYMBOL(drm_crtc_vblank_on_config);

/**
 * drm_crtc_vblank_on - enable vblank events on a CRTC
 * @crtc: CRTC in question
 *
 * This functions restores the vblank interrupt state captured with
 * drm_crtc_vblank_off() again and is generally called when enabling @crtc. Note
 * that calls to drm_crtc_vblank_on() and drm_crtc_vblank_off() can be
 * unbalanced and so can also be unconditionally called in driver load code to
 * reflect the current hardware state of the crtc.
 *
 * Note that unlike in drm_crtc_vblank_on_config(), default values are used.
 */
void drm_crtc_vblank_on(struct drm_crtc *crtc)
{
        const struct drm_vblank_crtc_config config = {
                .offdelay_ms = drm_vblank_offdelay,
                .disable_immediate = crtc->dev->vblank_disable_immediate
        };

        drm_crtc_vblank_on_config(crtc, &config);
}
EXPORT_SYMBOL(drm_crtc_vblank_on);

static void drm_vblank_restore(struct drm_device *dev, unsigned int pipe)
{
        ktime_t t_vblank;
        struct drm_vblank_crtc *vblank;
        int framedur_ns;
        u64 diff_ns;
        u32 cur_vblank, diff = 1;
        u32 max_vblank_count = drm_max_vblank_count(dev, pipe);

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return;

        assert_spin_locked(&dev->vbl_lock);
        assert_spin_locked(&dev->vblank_time_lock);

        vblank = drm_vblank_crtc(dev, pipe);
        drm_WARN_ONCE(dev,
                      drm_debug_enabled(DRM_UT_VBL) && !vblank->framedur_ns,
                      "Cannot compute missed vblanks without frame duration\n");
        framedur_ns = vblank->framedur_ns;

        get_vblank_counter_and_timestamp(dev, pipe, &cur_vblank,
                                         &t_vblank, false);

        diff_ns = ktime_to_ns(ktime_sub(t_vblank, vblank->time));
        if (framedur_ns)
                diff = DIV_ROUND_CLOSEST_ULL(diff_ns, framedur_ns);


        drm_dbg_vbl(dev,
                    "missed %d vblanks in %lld ns, frame duration=%d ns, hw_diff=%d\n",
                    diff, diff_ns, framedur_ns, cur_vblank - vblank->last);
        vblank->last = (cur_vblank - diff) & max_vblank_count;
}

/**
 * drm_crtc_vblank_restore - estimate missed vblanks and update vblank count.
 * @crtc: CRTC in question
 *
 * Power manamement features can cause frame counter resets between vblank
 * disable and enable. Drivers can use this function in their
 * &drm_crtc_funcs.enable_vblank implementation to estimate missed vblanks since
 * the last &drm_crtc_funcs.disable_vblank using timestamps and update the
 * vblank counter.
 *
 * Note that drivers must have race-free high-precision timestamping support,
 * i.e.  &drm_crtc_funcs.get_vblank_timestamp must be hooked up and
 * &drm_vblank_crtc_config.disable_immediate must be set to indicate the
 * time-stamping functions are race-free against vblank hardware counter
 * increments.
 */
void drm_crtc_vblank_restore(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;
        unsigned int pipe = drm_crtc_index(crtc);
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);

        drm_WARN_ON_ONCE(dev, !crtc->funcs->get_vblank_timestamp);
        drm_WARN_ON_ONCE(dev, vblank->inmodeset);
        drm_WARN_ON_ONCE(dev, !vblank->config.disable_immediate);

        drm_vblank_restore(dev, pipe);
}
EXPORT_SYMBOL(drm_crtc_vblank_restore);

static int drm_queue_vblank_event(struct drm_device *dev, unsigned int pipe,
                                  u64 req_seq,
                                  union drm_wait_vblank *vblwait,
                                  struct drm_file *file_priv)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        struct drm_pending_vblank_event *e;
        ktime_t now;
        u64 seq;
        int ret;

        e = kzalloc_obj(*e);
        if (e == NULL) {
                ret = -ENOMEM;
                goto err_put;
        }

        e->pipe = pipe;
        e->event.base.type = DRM_EVENT_VBLANK;
        e->event.base.length = sizeof(e->event.vbl);
        e->event.vbl.user_data = vblwait->request.signal;
        e->event.vbl.crtc_id = 0;
        if (drm_core_check_feature(dev, DRIVER_MODESET)) {
                struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);

                if (crtc)
                        e->event.vbl.crtc_id = crtc->base.id;
        }

        spin_lock_irq(&dev->event_lock);

        /*
         * drm_crtc_vblank_off() might have been called after we called
         * drm_vblank_get(). drm_crtc_vblank_off() holds event_lock around the
         * vblank disable, so no need for further locking.  The reference from
         * drm_vblank_get() protects against vblank disable from another source.
         */
        if (!READ_ONCE(vblank->enabled)) {
                ret = -EINVAL;
                goto err_unlock;
        }

        ret = drm_event_reserve_init_locked(dev, file_priv, &e->base,
                                            &e->event.base);

        if (ret)
                goto err_unlock;

        seq = drm_vblank_count_and_time(dev, pipe, &now);

        drm_dbg_core(dev, "event on vblank count %llu, current %llu, crtc %u\n",
                     req_seq, seq, pipe);

        trace_drm_vblank_event_queued(file_priv, pipe, req_seq);

        e->sequence = req_seq;
        if (drm_vblank_passed(seq, req_seq)) {
                drm_vblank_put(dev, pipe);
                send_vblank_event(dev, e, seq, now);
                vblwait->reply.sequence = seq;
        } else {
                /* drm_handle_vblank_events will call drm_vblank_put */
                list_add_tail(&e->base.link, &dev->vblank_event_list);
                vblwait->reply.sequence = req_seq;
        }

        spin_unlock_irq(&dev->event_lock);

        return 0;

err_unlock:
        spin_unlock_irq(&dev->event_lock);
        kfree(e);
err_put:
        drm_vblank_put(dev, pipe);
        return ret;
}

static bool drm_wait_vblank_is_query(union drm_wait_vblank *vblwait)
{
        if (vblwait->request.sequence)
                return false;

        return _DRM_VBLANK_RELATIVE ==
                (vblwait->request.type & (_DRM_VBLANK_TYPES_MASK |
                                          _DRM_VBLANK_EVENT |
                                          _DRM_VBLANK_NEXTONMISS));
}

/*
 * Widen a 32-bit param to 64-bits.
 *
 * \param narrow 32-bit value (missing upper 32 bits)
 * \param near 64-bit value that should be 'close' to near
 *
 * This function returns a 64-bit value using the lower 32-bits from
 * 'narrow' and constructing the upper 32-bits so that the result is
 * as close as possible to 'near'.
 */

static u64 widen_32_to_64(u32 narrow, u64 near)
{
        return near + (s32) (narrow - near);
}

static void drm_wait_vblank_reply(struct drm_device *dev, unsigned int pipe,
                                  struct drm_wait_vblank_reply *reply)
{
        ktime_t now;
        struct timespec64 ts;

        /*
         * drm_wait_vblank_reply is a UAPI structure that uses 'long'
         * to store the seconds. This is safe as we always use monotonic
         * timestamps since linux-4.15.
         */
        reply->sequence = drm_vblank_count_and_time(dev, pipe, &now);
        ts = ktime_to_timespec64(now);
        reply->tval_sec = (u32)ts.tv_sec;
        reply->tval_usec = ts.tv_nsec / 1000;
}

static bool drm_wait_vblank_supported(struct drm_device *dev)
{
        return drm_dev_has_vblank(dev);
}

int drm_wait_vblank_ioctl(struct drm_device *dev, void *data,
                          struct drm_file *file_priv)
{
        struct drm_crtc *crtc;
        struct drm_vblank_crtc *vblank;
        union drm_wait_vblank *vblwait = data;
        int ret;
        u64 req_seq, seq;
        unsigned int pipe_index;
        unsigned int flags, pipe, high_pipe;

        if (!drm_wait_vblank_supported(dev))
                return -EOPNOTSUPP;

        if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
                return -EINVAL;

        if (vblwait->request.type &
            ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
              _DRM_VBLANK_HIGH_CRTC_MASK)) {
                drm_dbg_core(dev,
                             "Unsupported type value 0x%x, supported mask 0x%x\n",
                             vblwait->request.type,
                             (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
                              _DRM_VBLANK_HIGH_CRTC_MASK));
                return -EINVAL;
        }

        flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
        high_pipe = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
        if (high_pipe)
                pipe_index = high_pipe >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
        else
                pipe_index = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;

        /* Convert lease-relative crtc index into global crtc index */
        if (drm_core_check_feature(dev, DRIVER_MODESET)) {
                pipe = 0;
                drm_for_each_crtc(crtc, dev) {
                        if (drm_lease_held(file_priv, crtc->base.id)) {
                                if (pipe_index == 0)
                                        break;
                                pipe_index--;
                        }
                        pipe++;
                }
        } else {
                pipe = pipe_index;
        }

        if (pipe >= dev->num_crtcs)
                return -EINVAL;

        vblank = drm_vblank_crtc(dev, pipe);

        /* If the counter is currently enabled and accurate, short-circuit
         * queries to return the cached timestamp of the last vblank.
         */
        if (vblank->config.disable_immediate &&
            drm_wait_vblank_is_query(vblwait) &&
            READ_ONCE(vblank->enabled)) {
                drm_wait_vblank_reply(dev, pipe, &vblwait->reply);
                return 0;
        }

        ret = drm_vblank_get(dev, pipe);
        if (ret) {
                drm_dbg_core(dev,
                             "crtc %d failed to acquire vblank counter, %d\n",
                             pipe, ret);
                return ret;
        }
        seq = drm_vblank_count(dev, pipe);

        switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
        case _DRM_VBLANK_RELATIVE:
                req_seq = seq + vblwait->request.sequence;
                vblwait->request.sequence = req_seq;
                vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
                break;
        case _DRM_VBLANK_ABSOLUTE:
                req_seq = widen_32_to_64(vblwait->request.sequence, seq);
                break;
        default:
                ret = -EINVAL;
                goto done;
        }

        if ((flags & _DRM_VBLANK_NEXTONMISS) &&
            drm_vblank_passed(seq, req_seq)) {
                req_seq = seq + 1;
                vblwait->request.type &= ~_DRM_VBLANK_NEXTONMISS;
                vblwait->request.sequence = req_seq;
        }

        if (flags & _DRM_VBLANK_EVENT) {
                /* must hold on to the vblank ref until the event fires
                 * drm_vblank_put will be called asynchronously
                 */
                return drm_queue_vblank_event(dev, pipe, req_seq, vblwait, file_priv);
        }

        if (req_seq != seq) {
                int wait;

                drm_dbg_core(dev, "waiting on vblank count %llu, crtc %u\n",
                             req_seq, pipe);
                wait = wait_event_interruptible_timeout(vblank->queue,
                        drm_vblank_passed(drm_vblank_count(dev, pipe), req_seq) ||
                                      !READ_ONCE(vblank->enabled),
                        msecs_to_jiffies(3000));

                switch (wait) {
                case 0:
                        /* timeout */
                        ret = -EBUSY;
                        break;
                case -ERESTARTSYS:
                        /* interrupted by signal */
                        ret = -EINTR;
                        break;
                default:
                        ret = 0;
                        break;
                }
        }

        if (ret != -EINTR) {
                drm_wait_vblank_reply(dev, pipe, &vblwait->reply);

                drm_dbg_core(dev, "crtc %d returning %u to client\n",
                             pipe, vblwait->reply.sequence);
        } else {
                drm_dbg_core(dev, "crtc %d vblank wait interrupted by signal\n",
                             pipe);
        }

done:
        drm_vblank_put(dev, pipe);
        return ret;
}

static void drm_handle_vblank_events(struct drm_device *dev, unsigned int pipe)
{
        struct drm_crtc *crtc = drm_crtc_from_index(dev, pipe);
        bool high_prec = false;
        struct drm_pending_vblank_event *e, *t;
        ktime_t now;
        u64 seq;

        assert_spin_locked(&dev->event_lock);

        seq = drm_vblank_count_and_time(dev, pipe, &now);

        list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
                if (e->pipe != pipe)
                        continue;
                if (!drm_vblank_passed(seq, e->sequence))
                        continue;

                drm_dbg_core(dev, "vblank event on %llu, current %llu\n",
                             e->sequence, seq);

                list_del(&e->base.link);
                drm_vblank_put(dev, pipe);
                send_vblank_event(dev, e, seq, now);
        }

        if (crtc && crtc->funcs->get_vblank_timestamp)
                high_prec = true;

        trace_drm_vblank_event(pipe, seq, now, high_prec);
}

/**
 * drm_handle_vblank - handle a vblank event
 * @dev: DRM device
 * @pipe: index of CRTC where this event occurred
 *
 * Drivers should call this routine in their vblank interrupt handlers to
 * update the vblank counter and send any signals that may be pending.
 *
 * This is the legacy version of drm_crtc_handle_vblank().
 */
bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe)
{
        struct drm_vblank_crtc *vblank = drm_vblank_crtc(dev, pipe);
        unsigned long irqflags;
        bool disable_irq;

        if (drm_WARN_ON_ONCE(dev, !drm_dev_has_vblank(dev)))
                return false;

        if (drm_WARN_ON(dev, pipe >= dev->num_crtcs))
                return false;

        spin_lock_irqsave(&dev->event_lock, irqflags);

        /* Need timestamp lock to prevent concurrent execution with
         * vblank enable/disable, as this would cause inconsistent
         * or corrupted timestamps and vblank counts.
         */
        spin_lock(&dev->vblank_time_lock);

        /* Vblank irq handling disabled. Nothing to do. */
        if (!vblank->enabled) {
                spin_unlock(&dev->vblank_time_lock);
                spin_unlock_irqrestore(&dev->event_lock, irqflags);
                return false;
        }

        drm_update_vblank_count(dev, pipe, true);

        spin_unlock(&dev->vblank_time_lock);

        wake_up(&vblank->queue);

        /* With instant-off, we defer disabling the interrupt until after
         * we finish processing the following vblank after all events have
         * been signaled. The disable has to be last (after
         * drm_handle_vblank_events) so that the timestamp is always accurate.
         */
        disable_irq = (vblank->config.disable_immediate &&
                       vblank->config.offdelay_ms > 0 &&
                       !atomic_read(&vblank->refcount));

        drm_handle_vblank_events(dev, pipe);
        drm_handle_vblank_works(vblank);

        spin_unlock_irqrestore(&dev->event_lock, irqflags);

        if (disable_irq)
                vblank_disable_fn(&vblank->disable_timer);

        return true;
}
EXPORT_SYMBOL(drm_handle_vblank);

/**
 * drm_crtc_handle_vblank - handle a vblank event
 * @crtc: where this event occurred
 *
 * Drivers should call this routine in their vblank interrupt handlers to
 * update the vblank counter and send any signals that may be pending.
 *
 * This is the native KMS version of drm_handle_vblank().
 *
 * Note that for a given vblank counter value drm_crtc_handle_vblank()
 * and drm_crtc_vblank_count() or drm_crtc_vblank_count_and_time()
 * provide a barrier: Any writes done before calling
 * drm_crtc_handle_vblank() will be visible to callers of the later
 * functions, if the vblank count is the same or a later one.
 *
 * See also &drm_vblank_crtc.count.
 *
 * Returns:
 * True if the event was successfully handled, false on failure.
 */
bool drm_crtc_handle_vblank(struct drm_crtc *crtc)
{
        return drm_handle_vblank(crtc->dev, drm_crtc_index(crtc));
}
EXPORT_SYMBOL(drm_crtc_handle_vblank);

/*
 * Get crtc VBLANK count.
 *
 * \param dev DRM device
 * \param data user argument, pointing to a drm_crtc_get_sequence structure.
 * \param file_priv drm file private for the user's open file descriptor
 */

int drm_crtc_get_sequence_ioctl(struct drm_device *dev, void *data,
                                struct drm_file *file_priv)
{
        struct drm_crtc *crtc;
        struct drm_vblank_crtc *vblank;
        int pipe;
        struct drm_crtc_get_sequence *get_seq = data;
        ktime_t now;
        bool vblank_enabled;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EOPNOTSUPP;

        if (!drm_dev_has_vblank(dev))
                return -EOPNOTSUPP;

        crtc = drm_crtc_find(dev, file_priv, get_seq->crtc_id);
        if (!crtc)
                return -ENOENT;

        pipe = drm_crtc_index(crtc);

        vblank = drm_crtc_vblank_crtc(crtc);
        vblank_enabled = READ_ONCE(vblank->config.disable_immediate) &&
                READ_ONCE(vblank->enabled);

        if (!vblank_enabled) {
                ret = drm_crtc_vblank_get(crtc);
                if (ret) {
                        drm_dbg_core(dev,
                                     "crtc %d failed to acquire vblank counter, %d\n",
                                     pipe, ret);
                        return ret;
                }
        }
        drm_modeset_lock(&crtc->mutex, NULL);
        if (crtc->state)
                get_seq->active = crtc->state->enable;
        else
                get_seq->active = crtc->enabled;
        drm_modeset_unlock(&crtc->mutex);
        get_seq->sequence = drm_vblank_count_and_time(dev, pipe, &now);
        get_seq->sequence_ns = ktime_to_ns(now);
        if (!vblank_enabled)
                drm_crtc_vblank_put(crtc);
        return 0;
}

/*
 * Queue a event for VBLANK sequence
 *
 * \param dev DRM device
 * \param data user argument, pointing to a drm_crtc_queue_sequence structure.
 * \param file_priv drm file private for the user's open file descriptor
 */

int drm_crtc_queue_sequence_ioctl(struct drm_device *dev, void *data,
                                  struct drm_file *file_priv)
{
        struct drm_crtc *crtc;
        struct drm_vblank_crtc *vblank;
        int pipe;
        struct drm_crtc_queue_sequence *queue_seq = data;
        ktime_t now;
        struct drm_pending_vblank_event *e;
        u32 flags;
        u64 seq;
        u64 req_seq;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EOPNOTSUPP;

        if (!drm_dev_has_vblank(dev))
                return -EOPNOTSUPP;

        crtc = drm_crtc_find(dev, file_priv, queue_seq->crtc_id);
        if (!crtc)
                return -ENOENT;

        flags = queue_seq->flags;
        /* Check valid flag bits */
        if (flags & ~(DRM_CRTC_SEQUENCE_RELATIVE|
                      DRM_CRTC_SEQUENCE_NEXT_ON_MISS))
                return -EINVAL;

        pipe = drm_crtc_index(crtc);

        vblank = drm_crtc_vblank_crtc(crtc);

        e = kzalloc_obj(*e);
        if (e == NULL)
                return -ENOMEM;

        ret = drm_crtc_vblank_get(crtc);
        if (ret) {
                drm_dbg_core(dev,
                             "crtc %d failed to acquire vblank counter, %d\n",
                             pipe, ret);
                goto err_free;
        }

        seq = drm_vblank_count_and_time(dev, pipe, &now);
        req_seq = queue_seq->sequence;

        if (flags & DRM_CRTC_SEQUENCE_RELATIVE)
                req_seq += seq;

        if ((flags & DRM_CRTC_SEQUENCE_NEXT_ON_MISS) && drm_vblank_passed(seq, req_seq))
                req_seq = seq + 1;

        e->pipe = pipe;
        e->event.base.type = DRM_EVENT_CRTC_SEQUENCE;
        e->event.base.length = sizeof(e->event.seq);
        e->event.seq.user_data = queue_seq->user_data;

        spin_lock_irq(&dev->event_lock);

        /*
         * drm_crtc_vblank_off() might have been called after we called
         * drm_crtc_vblank_get(). drm_crtc_vblank_off() holds event_lock around the
         * vblank disable, so no need for further locking.  The reference from
         * drm_crtc_vblank_get() protects against vblank disable from another source.
         */
        if (!READ_ONCE(vblank->enabled)) {
                ret = -EINVAL;
                goto err_unlock;
        }

        ret = drm_event_reserve_init_locked(dev, file_priv, &e->base,
                                            &e->event.base);

        if (ret)
                goto err_unlock;

        e->sequence = req_seq;

        if (drm_vblank_passed(seq, req_seq)) {
                drm_crtc_vblank_put(crtc);
                send_vblank_event(dev, e, seq, now);
                queue_seq->sequence = seq;
        } else {
                /* drm_handle_vblank_events will call drm_vblank_put */
                list_add_tail(&e->base.link, &dev->vblank_event_list);
                queue_seq->sequence = req_seq;
        }

        spin_unlock_irq(&dev->event_lock);
        return 0;

err_unlock:
        spin_unlock_irq(&dev->event_lock);
        drm_crtc_vblank_put(crtc);
err_free:
        kfree(e);
        return ret;
}

/*
 * VBLANK timer
 */

static enum hrtimer_restart drm_vblank_timer_function(struct hrtimer *timer)
{
        struct drm_vblank_crtc_timer *vtimer =
                container_of(timer, struct drm_vblank_crtc_timer, timer);
        struct drm_crtc *crtc = vtimer->crtc;
        const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
        struct drm_device *dev = crtc->dev;
        unsigned long flags;
        ktime_t interval;
        u64 ret_overrun;
        bool succ;

        spin_lock_irqsave(&vtimer->interval_lock, flags);
        interval = vtimer->interval;
        spin_unlock_irqrestore(&vtimer->interval_lock, flags);

        if (!interval)
                return HRTIMER_NORESTART;

        ret_overrun = hrtimer_forward_now(&vtimer->timer, interval);
        if (ret_overrun != 1)
                drm_dbg_vbl(dev, "vblank timer overrun\n");

        if (crtc_funcs->handle_vblank_timeout)
                succ = crtc_funcs->handle_vblank_timeout(crtc);
        else
                succ = drm_crtc_handle_vblank(crtc);
        if (!succ)
                return HRTIMER_NORESTART;

        return HRTIMER_RESTART;
}

/**
 * drm_crtc_vblank_start_timer - Starts the vblank timer on the given CRTC
 * @crtc: the CRTC
 *
 * Drivers should call this function from their CRTC's enable_vblank
 * function to start a vblank timer. The timer will fire after the duration
 * of a full frame. drm_crtc_vblank_cancel_timer() disables a running timer.
 *
 * Returns:
 * 0 on success, or a negative errno code otherwise.
 */
int drm_crtc_vblank_start_timer(struct drm_crtc *crtc)
{
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        struct drm_vblank_crtc_timer *vtimer = &vblank->vblank_timer;
        unsigned long flags;

        if (!vtimer->crtc) {
                /*
                 * Set up the data structures on the first invocation.
                 */
                vtimer->crtc = crtc;
                spin_lock_init(&vtimer->interval_lock);
                hrtimer_setup(&vtimer->timer, drm_vblank_timer_function,
                              CLOCK_MONOTONIC, HRTIMER_MODE_REL);
        } else {
                /*
                 * Timer should not be active. If it is, wait for the
                 * previous cancel operations to finish.
                 */
                while (hrtimer_active(&vtimer->timer))
                        hrtimer_try_to_cancel(&vtimer->timer);
        }

        drm_calc_timestamping_constants(crtc, &crtc->mode);

        spin_lock_irqsave(&vtimer->interval_lock, flags);
        vtimer->interval = ns_to_ktime(vblank->framedur_ns);
        spin_unlock_irqrestore(&vtimer->interval_lock, flags);

        hrtimer_start(&vtimer->timer, vtimer->interval, HRTIMER_MODE_REL);

        return 0;
}
EXPORT_SYMBOL(drm_crtc_vblank_start_timer);

/**
 * drm_crtc_vblank_cancel_timer - Cancels the given CRTC's vblank timer
 * @crtc: the CRTC
 *
 * Drivers should call this function from their CRTC's disable_vblank
 * function to stop a vblank timer.
 */
void drm_crtc_vblank_cancel_timer(struct drm_crtc *crtc)
{
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        struct drm_vblank_crtc_timer *vtimer = &vblank->vblank_timer;
        unsigned long flags;

        /*
         * Calling hrtimer_cancel() can result in a deadlock with DRM's
         * vblank_time_lime_lock and hrtimers' softirq_expiry_lock. So
         * clear interval and indicate cancellation. The timer function
         * will cancel itself on the next invocation.
         */

        spin_lock_irqsave(&vtimer->interval_lock, flags);
        vtimer->interval = 0;
        spin_unlock_irqrestore(&vtimer->interval_lock, flags);

        hrtimer_try_to_cancel(&vtimer->timer);
}
EXPORT_SYMBOL(drm_crtc_vblank_cancel_timer);

/**
 * drm_crtc_vblank_get_vblank_timeout - Returns the vblank timeout
 * @crtc: The CRTC
 * @vblank_time: Returns the next vblank timestamp
 *
 * The helper drm_crtc_vblank_get_vblank_timeout() returns the next vblank
 * timestamp of the CRTC's vblank timer according to the timer's expiry
 * time.
 */
void drm_crtc_vblank_get_vblank_timeout(struct drm_crtc *crtc, ktime_t *vblank_time)
{
        struct drm_vblank_crtc *vblank = drm_crtc_vblank_crtc(crtc);
        struct drm_vblank_crtc_timer *vtimer = &vblank->vblank_timer;
        u64 cur_count;
        ktime_t cur_time;

        if (!READ_ONCE(vblank->enabled)) {
                *vblank_time = ktime_get();
                return;
        }

        /*
         * A concurrent vblank timeout could update the expires field before
         * we compare it with the vblank time. Hence we'd compare the old
         * expiry time to the new vblank time; deducing the timer had already
         * expired. Reread until we get consistent values from both fields.
         */
        do {
                cur_count = drm_crtc_vblank_count_and_time(crtc, &cur_time);
                *vblank_time = READ_ONCE(vtimer->timer.node.expires);
        } while (cur_count != drm_crtc_vblank_count_and_time(crtc, &cur_time));

        if (drm_WARN_ON(crtc->dev, !ktime_compare(*vblank_time, cur_time)))
                return; /* Already expired */

        /*
         * To prevent races we roll the hrtimer forward before we do any
         * interrupt processing - this is how real hw works (the interrupt
         * is only generated after all the vblank registers are updated)
         * and what the vblank core expects. Therefore we need to always
         * correct the timestamp by one frame.
         */
        *vblank_time = ktime_sub(*vblank_time, vtimer->interval);
}
EXPORT_SYMBOL(drm_crtc_vblank_get_vblank_timeout);






























































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































    3 






    2 


    2 




    3 







    3 

    3 





    3 
    1 























































































































































































































































































































































































































































































































































































































































































































































    3 




    3 












    3 










    3 























































































































































































    3 


    3 






    3 

    2 


    1 

















































































































    3 
    3 



    3 

    3 















    3 




























































































































































































































































































































































    4 





















1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Z-Star/Vimicro zc301/zc302p/vc30x driver
 *
 * Copyright (C) 2009-2012 Jean-Francois Moine <http://moinejf.free.fr>
 * Copyright (C) 2004 2005 2006 Michel Xhaard mxhaard@magic.fr
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/input.h>
#include "gspca.h"
#include "jpeg.h"

MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>, Serge A. Suchkov <Serge.A.S@tochka.ru>");
MODULE_DESCRIPTION("GSPCA ZC03xx/VC3xx USB Camera Driver");
MODULE_LICENSE("GPL");

static int force_sensor = -1;

#define REG08_DEF 3                /* default JPEG compression (75%) */
#include "zc3xx-reg.h"

/* specific webcam descriptor */
struct sd {
        struct gspca_dev gspca_dev;        /* !! must be the first item */

        struct { /* gamma/brightness/contrast control cluster */
                struct v4l2_ctrl *gamma;
                struct v4l2_ctrl *brightness;
                struct v4l2_ctrl *contrast;
        };
        struct { /* autogain/exposure control cluster */
                struct v4l2_ctrl *autogain;
                struct v4l2_ctrl *exposure;
        };
        struct v4l2_ctrl *plfreq;
        struct v4l2_ctrl *sharpness;
        struct v4l2_ctrl *jpegqual;

        struct work_struct work;

        u8 reg08;                /* webcam compression quality */

        u8 bridge;
        u8 sensor;                /* Type of image sensor chip */
        u16 chip_revision;

        u8 jpeg_hdr[JPEG_HDR_SZ];
};
enum bridges {
        BRIDGE_ZC301,
        BRIDGE_ZC303,
};
enum sensors {
        SENSOR_ADCM2700,
        SENSOR_CS2102,
        SENSOR_CS2102K,
        SENSOR_GC0303,
        SENSOR_GC0305,
        SENSOR_HDCS2020,
        SENSOR_HV7131B,
        SENSOR_HV7131R,
        SENSOR_ICM105A,
        SENSOR_MC501CB,
        SENSOR_MT9V111_1,        /* (mi360soc) zc301 */
        SENSOR_MT9V111_3,        /* (mi360soc) zc303 */
        SENSOR_OV7620,                /* OV7648 - same values */
        SENSOR_OV7630C,
        SENSOR_PAS106,
        SENSOR_PAS202B,
        SENSOR_PB0330,
        SENSOR_PO2030,
        SENSOR_TAS5130C,
        SENSOR_MAX
};

static const struct v4l2_pix_format vga_mode[] = {
        {320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 320,
                .sizeimage = 320 * 240 * 3 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 1},
        {640, 480, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 640,
                .sizeimage = 640 * 480 * 3 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 0},
};

static const struct v4l2_pix_format broken_vga_mode[] = {
        {320, 232, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 320,
                .sizeimage = 320 * 232 * 4 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 1},
        {640, 472, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 640,
                .sizeimage = 640 * 472 * 3 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 0},
};

static const struct v4l2_pix_format sif_mode[] = {
        {176, 144, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 176,
                .sizeimage = 176 * 144 * 3 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 1},
        {352, 288, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
                .bytesperline = 352,
                .sizeimage = 352 * 288 * 3 / 8 + 590,
                .colorspace = V4L2_COLORSPACE_JPEG,
                .priv = 0},
};

/*
 * Bridge reg08 bits 1-2 -> JPEG quality conversion table. Note the highest
 * quality setting is not usable as USB 1 does not have enough bandwidth.
 */
static u8 jpeg_qual[] = {50, 75, 87, /* 94 */};

/* usb exchanges */
struct usb_action {
        u8        req;
        u8        val;
        u16        idx;
};

static const struct usb_action adcm2700_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},                /* 00,00,01,cc */
        {0xa0, 0x04, ZC3XX_R002_CLOCKSELECT},                /* 00,02,04,cc */
        {0xa0, 0x00, ZC3XX_R008_CLOCKSETTING},                /* 00,08,03,cc */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xa0, 0xd3, ZC3XX_R08B_I2CDEVICEADDR},                /* 00,8b,d3,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},                /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xd8, ZC3XX_R006_FRAMEHEIGHTLOW},        /* 00,06,d8,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,05,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},                /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},                /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},                /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},                /* 01,1c,00,cc */
        {0xa0, 0xde, ZC3XX_R09C_WINHEIGHTLOW},                /* 00,9c,de,cc */
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},                /* 00,9e,86,cc */
        {0xbb, 0x00, 0x0400},                                /* 04,00,00,bb */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x0f, 0x140f},                                /* 14,0f,0f,bb */
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,37,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},                /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},                /* 01,89,06,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},                /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},                /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},                /* 03,01,08,cc */
        {0xa0, 0x58, ZC3XX_R116_RGAIN},                        /* 01,16,58,cc */
        {0xa0, 0x5a, ZC3XX_R118_BGAIN},                        /* 01,18,5a,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},        /* 01,80,02,cc */
        {0xa0, 0xd3, ZC3XX_R08B_I2CDEVICEADDR},                /* 00,8b,d3,cc */
        {0xbb, 0x00, 0x0408},                                /* 04,00,08,bb */
        {0xdd, 0x00, 0x0200},                                /* 00,02,00,dd */
        {0xbb, 0x00, 0x0400},                                /* 04,00,00,bb */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x0f, 0x140f},                                /* 14,0f,0f,bb */
        {0xbb, 0xe0, 0x0c2e},                                /* 0c,e0,2e,bb */
        {0xbb, 0x01, 0x2000},                                /* 20,01,00,bb */
        {0xbb, 0x96, 0x2400},                                /* 24,96,00,bb */
        {0xbb, 0x06, 0x1006},                                /* 10,06,06,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x5f, 0x2090},                                /* 20,5f,90,bb */
        {0xbb, 0x01, 0x8000},                                /* 80,01,00,bb */
        {0xbb, 0x09, 0x8400},                                /* 84,09,00,bb */
        {0xbb, 0x86, 0x0002},                                /* 00,86,02,bb */
        {0xbb, 0xe6, 0x0401},                                /* 04,e6,01,bb */
        {0xbb, 0x86, 0x0802},                                /* 08,86,02,bb */
        {0xbb, 0xe6, 0x0c01},                                /* 0c,e6,01,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0000},                                /* 00,fe,00,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0020},                                /* 00,fe,20,aa */
/*mswin+*/
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},
        {0xaa, 0xfe, 0x0002},
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xaa, 0xb4, 0xcd37},
        {0xaa, 0xa4, 0x0004},
        {0xaa, 0xa8, 0x0007},
        {0xaa, 0xac, 0x0004},
/*mswin-*/
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0000},                                /* 00,fe,00,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x04, 0x0400},                                /* 04,04,00,bb */
        {0xdd, 0x00, 0x0100},                                /* 00,01,00,dd */
        {0xbb, 0x01, 0x0400},                                /* 04,01,00,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xbb, 0x41, 0x2803},                                /* 28,41,03,bb */
        {0xbb, 0x40, 0x2c03},                                /* 2c,40,03,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0010},                                /* 00,fe,10,aa */
        {}
};
static const struct usb_action adcm2700_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},                /* 00,00,01,cc */
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},                /* 00,02,10,cc */
        {0xa0, 0x00, ZC3XX_R008_CLOCKSETTING},                /* 00,08,03,cc */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xa0, 0xd3, ZC3XX_R08B_I2CDEVICEADDR},                /* 00,8b,d3,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},                /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xd0, ZC3XX_R006_FRAMEHEIGHTLOW},        /* 00,06,d0,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,05,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},                /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},                /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},                /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},                /* 01,1c,00,cc */
        {0xa0, 0xd8, ZC3XX_R09C_WINHEIGHTLOW},                /* 00,9c,d8,cc */
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},                /* 00,9e,88,cc */
        {0xbb, 0x00, 0x0400},                                /* 04,00,00,bb */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x0f, 0x140f},                                /* 14,0f,0f,bb */
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,37,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},                /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},                /* 01,89,06,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},                /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},                /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},                /* 03,01,08,cc */
        {0xa0, 0x58, ZC3XX_R116_RGAIN},                        /* 01,16,58,cc */
        {0xa0, 0x5a, ZC3XX_R118_BGAIN},                        /* 01,18,5a,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},        /* 01,80,02,cc */
        {0xa0, 0xd3, ZC3XX_R08B_I2CDEVICEADDR},                /* 00,8b,d3,cc */
        {0xbb, 0x00, 0x0408},                                /* 04,00,08,bb */
        {0xdd, 0x00, 0x0200},                                /* 00,02,00,dd */
        {0xbb, 0x00, 0x0400},                                /* 04,00,00,bb */
        {0xdd, 0x00, 0x0050},                                /* 00,00,50,dd */
        {0xbb, 0x0f, 0x140f},                                /* 14,0f,0f,bb */
        {0xbb, 0xe0, 0x0c2e},                                /* 0c,e0,2e,bb */
        {0xbb, 0x01, 0x2000},                                /* 20,01,00,bb */
        {0xbb, 0x96, 0x2400},                                /* 24,96,00,bb */
        {0xbb, 0x06, 0x1006},                                /* 10,06,06,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x5f, 0x2090},                                /* 20,5f,90,bb */
        {0xbb, 0x01, 0x8000},                                /* 80,01,00,bb */
        {0xbb, 0x09, 0x8400},                                /* 84,09,00,bb */
        {0xbb, 0x86, 0x0002},                                /* 00,88,02,bb */
        {0xbb, 0xe6, 0x0401},                                /* 04,e6,01,bb */
        {0xbb, 0x86, 0x0802},                                /* 08,88,02,bb */
        {0xbb, 0xe6, 0x0c01},                                /* 0c,e6,01,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0000},                                /* 00,fe,00,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0020},                                /* 00,fe,20,aa */
        /*******/
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xaa, 0xfe, 0x0000},                                /* 00,fe,00,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xdd, 0x00, 0x0010},                                /* 00,00,10,dd */
        {0xbb, 0x04, 0x0400},                                /* 04,04,00,bb */
        {0xdd, 0x00, 0x0100},                                /* 00,01,00,dd */
        {0xbb, 0x01, 0x0400},                                /* 04,01,00,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xbb, 0x41, 0x2803},                                /* 28,41,03,bb */
        {0xbb, 0x40, 0x2c03},                                /* 2c,40,03,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0010},                                /* 00,fe,10,aa */
        {}
};
static const struct usb_action adcm2700_50HZ[] = {
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xbb, 0x05, 0x8400},                                /* 84,05,00,bb */
        {0xbb, 0xd0, 0xb007},                                /* b0,d0,07,bb */
        {0xbb, 0xa0, 0xb80f},                                /* b8,a0,0f,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0010},                                /* 00,fe,10,aa */
        {0xaa, 0x26, 0x00d0},                                /* 00,26,d0,aa */
        {0xaa, 0x28, 0x0002},                                /* 00,28,02,aa */
        {}
};
static const struct usb_action adcm2700_60HZ[] = {
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xbb, 0x07, 0x8400},                                /* 84,07,00,bb */
        {0xbb, 0x82, 0xb006},                                /* b0,82,06,bb */
        {0xbb, 0x04, 0xb80d},                                /* b8,04,0d,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0010},                                /* 00,fe,10,aa */
        {0xaa, 0x26, 0x0057},                                /* 00,26,57,aa */
        {0xaa, 0x28, 0x0002},                                /* 00,28,02,aa */
        {}
};
static const struct usb_action adcm2700_NoFlicker[] = {
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0002},                                /* 00,fe,02,aa */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0a,cc */
        {0xbb, 0x07, 0x8400},                                /* 84,07,00,bb */
        {0xbb, 0x05, 0xb000},                                /* b0,05,00,bb */
        {0xbb, 0xa0, 0xb801},                                /* b8,a0,01,bb */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xaa, 0xfe, 0x0010},                                /* 00,fe,10,aa */
        {}
};
static const struct usb_action cs2102_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x00, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x20, ZC3XX_R080_HBLANKHIGH},
        {0xa0, 0x21, ZC3XX_R081_HBLANKLOW},
        {0xa0, 0x30, ZC3XX_R083_RGAINADDR},
        {0xa0, 0x31, ZC3XX_R084_GGAINADDR},
        {0xa0, 0x32, ZC3XX_R085_BGAINADDR},
        {0xa0, 0x23, ZC3XX_R086_EXPTIMEHIGH},
        {0xa0, 0x24, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x25, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0xb3, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xaa, 0x02, 0x0008},
        {0xaa, 0x03, 0x0000},
        {0xaa, 0x11, 0x0000},
        {0xaa, 0x12, 0x0089},
        {0xaa, 0x13, 0x0000},
        {0xaa, 0x14, 0x00e9},
        {0xaa, 0x20, 0x0000},
        {0xaa, 0x22, 0x0000},
        {0xaa, 0x0b, 0x0004},
        {0xaa, 0x30, 0x0030},
        {0xaa, 0x31, 0x0030},
        {0xaa, 0x32, 0x0030},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x10, 0x01ae},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x68, ZC3XX_R18D_YTARGET},
        {0xa0, 0x00, 0x01ad},
        {}
};

static const struct usb_action cs2102_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x00, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x20, ZC3XX_R080_HBLANKHIGH},
        {0xa0, 0x21, ZC3XX_R081_HBLANKLOW},
        {0xa0, 0x30, ZC3XX_R083_RGAINADDR},
        {0xa0, 0x31, ZC3XX_R084_GGAINADDR},
        {0xa0, 0x32, ZC3XX_R085_BGAINADDR},
        {0xa0, 0x23, ZC3XX_R086_EXPTIMEHIGH},
        {0xa0, 0x24, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x25, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0xb3, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xaa, 0x02, 0x0008},
        {0xaa, 0x03, 0x0000},
        {0xaa, 0x11, 0x0001},
        {0xaa, 0x12, 0x0087},
        {0xaa, 0x13, 0x0001},
        {0xaa, 0x14, 0x00e7},
        {0xaa, 0x20, 0x0000},
        {0xaa, 0x22, 0x0000},
        {0xaa, 0x0b, 0x0004},
        {0xaa, 0x30, 0x0030},
        {0xaa, 0x31, 0x0030},
        {0xaa, 0x32, 0x0030},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x15, 0x01ae},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x68, ZC3XX_R18D_YTARGET},
        {0xa0, 0x00, 0x01ad},
        {}
};
static const struct usb_action cs2102_50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0001},
        {0xaa, 0x24, 0x005f},
        {0xaa, 0x25, 0x0090},
        {0xaa, 0x21, 0x00dd},
        {0xa0, 0x02, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xbf, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x20, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x3a, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x98, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xdd, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xe4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action cs2102_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0000},
        {0xaa, 0x24, 0x00af},
        {0xaa, 0x25, 0x00c8},
        {0xaa, 0x21, 0x0068},
        {0xa0, 0x01, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x5f, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x90, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x1d, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x4c, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x68, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xe3, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action cs2102_60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0001},
        {0xaa, 0x24, 0x0055},
        {0xaa, 0x25, 0x00cc},
        {0xaa, 0x21, 0x003f},
        {0xa0, 0x02, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xab, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x98, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x30, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0xd4, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x39, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x70, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xb0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action cs2102_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0000},
        {0xaa, 0x24, 0x00aa},
        {0xaa, 0x25, 0x00e6},
        {0xaa, 0x21, 0x003f},
        {0xa0, 0x01, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x55, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xcc, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x18, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x6a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x3f, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xa5, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action cs2102_NoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0001},
        {0xaa, 0x24, 0x005f},
        {0xaa, 0x25, 0x0000},
        {0xaa, 0x21, 0x0001},
        {0xa0, 0x02, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xbf, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x80, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x01, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x40, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xa0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action cs2102_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x23, 0x0000},
        {0xaa, 0x24, 0x00af},
        {0xaa, 0x25, 0x0080},
        {0xaa, 0x21, 0x0001},
        {0xa0, 0x01, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x5f, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x80, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x80, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x01, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x40, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xa0, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {}
};

/* CS2102_KOCOM */
static const struct usb_action cs2102K_InitialScale[] = {
        {0xa0, 0x11, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xa0, 0x55, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0a, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0b, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0c, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x7c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0d, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xa3, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x03, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xfb, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x05, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x06, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x03, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x09, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x08, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0e, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0f, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x10, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x11, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x12, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x15, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x16, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x17, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x01, 0x01b1},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x4c, ZC3XX_R118_BGAIN},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x13, ZC3XX_R120_GAMMA00},        /* gamma 4 */
        {0xa0, 0x38, ZC3XX_R121_GAMMA01},
        {0xa0, 0x59, ZC3XX_R122_GAMMA02},
        {0xa0, 0x79, ZC3XX_R123_GAMMA03},
        {0xa0, 0x92, ZC3XX_R124_GAMMA04},
        {0xa0, 0xa7, ZC3XX_R125_GAMMA05},
        {0xa0, 0xb9, ZC3XX_R126_GAMMA06},
        {0xa0, 0xc8, ZC3XX_R127_GAMMA07},
        {0xa0, 0xd4, ZC3XX_R128_GAMMA08},
        {0xa0, 0xdf, ZC3XX_R129_GAMMA09},
        {0xa0, 0xe7, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xee, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xf4, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xf9, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xfc, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x26, ZC3XX_R130_GAMMA10},
        {0xa0, 0x22, ZC3XX_R131_GAMMA11},
        {0xa0, 0x20, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1c, ZC3XX_R133_GAMMA13},
        {0xa0, 0x16, ZC3XX_R134_GAMMA14},
        {0xa0, 0x13, ZC3XX_R135_GAMMA15},
        {0xa0, 0x10, ZC3XX_R136_GAMMA16},
        {0xa0, 0x0d, ZC3XX_R137_GAMMA17},
        {0xa0, 0x0b, ZC3XX_R138_GAMMA18},
        {0xa0, 0x09, ZC3XX_R139_GAMMA19},
        {0xa0, 0x07, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x06, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x05, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x04, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x03, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x02, ZC3XX_R13F_GAMMA1F},
        {0xa0, 0x58, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf4, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf4, ZC3XX_R10D_RGB10},
        {0xa0, 0x58, ZC3XX_R10E_RGB11},
        {0xa0, 0xf4, ZC3XX_R10F_RGB12},
        {0xa0, 0xf4, ZC3XX_R110_RGB20},
        {0xa0, 0xf4, ZC3XX_R111_RGB21},
        {0xa0, 0x58, ZC3XX_R112_RGB22},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x22, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x22, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x01, ZC3XX_R0A3_EXPOSURETIMEHIGH},
        {0xa0, 0x22, ZC3XX_R0A4_EXPOSURETIMELOW},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xee, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x3a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x0f, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x19, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x1f, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x4c, ZC3XX_R118_BGAIN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x5c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x5c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x96, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x96, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {}
};

static const struct usb_action cs2102K_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
/*fixme: next sequence = i2c exchanges*/
        {0xa0, 0x55, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0a, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0b, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0c, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x7b, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0d, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xa3, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x03, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xfb, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x05, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x06, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x03, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x09, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x08, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0e, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x0f, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x10, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x11, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x12, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x18, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x15, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x16, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x17, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0xf7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x01, 0x01b1},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x4c, ZC3XX_R118_BGAIN},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x13, ZC3XX_R120_GAMMA00},        /* gamma 4 */
        {0xa0, 0x38, ZC3XX_R121_GAMMA01},
        {0xa0, 0x59, ZC3XX_R122_GAMMA02},
        {0xa0, 0x79, ZC3XX_R123_GAMMA03},
        {0xa0, 0x92, ZC3XX_R124_GAMMA04},
        {0xa0, 0xa7, ZC3XX_R125_GAMMA05},
        {0xa0, 0xb9, ZC3XX_R126_GAMMA06},
        {0xa0, 0xc8, ZC3XX_R127_GAMMA07},
        {0xa0, 0xd4, ZC3XX_R128_GAMMA08},
        {0xa0, 0xdf, ZC3XX_R129_GAMMA09},
        {0xa0, 0xe7, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xee, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xf4, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xf9, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xfc, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x26, ZC3XX_R130_GAMMA10},
        {0xa0, 0x22, ZC3XX_R131_GAMMA11},
        {0xa0, 0x20, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1c, ZC3XX_R133_GAMMA13},
        {0xa0, 0x16, ZC3XX_R134_GAMMA14},
        {0xa0, 0x13, ZC3XX_R135_GAMMA15},
        {0xa0, 0x10, ZC3XX_R136_GAMMA16},
        {0xa0, 0x0d, ZC3XX_R137_GAMMA17},
        {0xa0, 0x0b, ZC3XX_R138_GAMMA18},
        {0xa0, 0x09, ZC3XX_R139_GAMMA19},
        {0xa0, 0x07, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x06, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x05, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x04, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x03, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x02, ZC3XX_R13F_GAMMA1F},
        {0xa0, 0x58, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf4, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf4, ZC3XX_R10D_RGB10},
        {0xa0, 0x58, ZC3XX_R10E_RGB11},
        {0xa0, 0xf4, ZC3XX_R10F_RGB12},
        {0xa0, 0xf4, ZC3XX_R110_RGB20},
        {0xa0, 0xf4, ZC3XX_R111_RGB21},
        {0xa0, 0x58, ZC3XX_R112_RGB22},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x22, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x22, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x01, ZC3XX_R0A3_EXPOSURETIMEHIGH},
        {0xa0, 0x22, ZC3XX_R0A4_EXPOSURETIMELOW},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xee, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x3a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x0f, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x19, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x1f, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x4c, ZC3XX_R118_BGAIN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x5c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x5c, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x96, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x96, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
/*fixme:what does the next sequence?*/
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xd0, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0xd0, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x01, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x02, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0a, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x0a, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x44, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x44, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x20, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x21, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x7e, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x00, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x13, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x7e, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x14, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x02, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x18, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x04, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x00, ZC3XX_R094_I2CWRITEACK},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {}
};

static const struct usb_action gc0305_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},        /* 00,00,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00,08,03,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xa0, 0x04, ZC3XX_R002_CLOCKSELECT},        /* 00,02,04,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},        /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},        /* 00,06,e0,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},        /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},        /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},        /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},        /* 01,1c,00,cc */
        {0xa0, 0xe6, ZC3XX_R09C_WINHEIGHTLOW},        /* 00,9c,e6,cc */
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},        /* 00,9e,86,cc */
        {0xa0, 0x98, ZC3XX_R08B_I2CDEVICEADDR},        /* 00,8b,98,cc */
        {0xaa, 0x13, 0x0002},        /* 00,13,02,aa */
        {0xaa, 0x15, 0x0003},        /* 00,15,03,aa */
        {0xaa, 0x01, 0x0000},        /* 00,01,00,aa */
        {0xaa, 0x02, 0x0000},        /* 00,02,00,aa */
        {0xaa, 0x1a, 0x0000},        /* 00,1a,00,aa */
        {0xaa, 0x1c, 0x0017},        /* 00,1c,17,aa */
        {0xaa, 0x1d, 0x0080},        /* 00,1d,80,aa */
        {0xaa, 0x1f, 0x0008},        /* 00,1f,08,aa */
        {0xaa, 0x21, 0x0012},        /* 00,21,12,aa */
        {0xa0, 0x82, ZC3XX_R086_EXPTIMEHIGH},        /* 00,86,82,cc */
        {0xa0, 0x83, ZC3XX_R087_EXPTIMEMID},        /* 00,87,83,cc */
        {0xa0, 0x84, ZC3XX_R088_EXPTIMELOW},        /* 00,88,84,cc */
        {0xaa, 0x05, 0x0000},        /* 00,05,00,aa */
        {0xaa, 0x0a, 0x0000},        /* 00,0a,00,aa */
        {0xaa, 0x0b, 0x00b0},        /* 00,0b,b0,aa */
        {0xaa, 0x0c, 0x0000},        /* 00,0c,00,aa */
        {0xaa, 0x0d, 0x00b0},        /* 00,0d,b0,aa */
        {0xaa, 0x0e, 0x0000},        /* 00,0e,00,aa */
        {0xaa, 0x0f, 0x00b0},        /* 00,0f,b0,aa */
        {0xaa, 0x10, 0x0000},        /* 00,10,00,aa */
        {0xaa, 0x11, 0x00b0},        /* 00,11,b0,aa */
        {0xaa, 0x16, 0x0001},        /* 00,16,01,aa */
        {0xaa, 0x17, 0x00e6},        /* 00,17,e6,aa */
        {0xaa, 0x18, 0x0002},        /* 00,18,02,aa */
        {0xaa, 0x19, 0x0086},        /* 00,19,86,aa */
        {0xaa, 0x20, 0x0000},        /* 00,20,00,aa */
        {0xaa, 0x1b, 0x0020},        /* 00,1b,20,aa */
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,b7,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,05,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},        /* 01,00,0d,cc */
        {0xa0, 0x76, ZC3XX_R189_AWBSTATUS},        /* 01,89,76,cc */
        {0xa0, 0x09, 0x01ad},        /* 01,ad,09,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},        /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},        /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},        /* 03,01,08,cc */
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},        /* 01,a8,60,cc */
        {0xa0, 0x85, ZC3XX_R18D_YTARGET},        /* 01,8d,85,cc */
        {0xa0, 0x00, 0x011e},        /* 01,1e,00,cc */
        {0xa0, 0x52, ZC3XX_R116_RGAIN},        /* 01,16,52,cc */
        {0xa0, 0x40, ZC3XX_R117_GGAIN},        /* 01,17,40,cc */
        {0xa0, 0x52, ZC3XX_R118_BGAIN},        /* 01,18,52,cc */
        {0xa0, 0x03, ZC3XX_R113_RGB03},        /* 01,13,03,cc */
        {}
};
static const struct usb_action gc0305_InitialScale[] = { /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},        /* 00,00,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00,08,03,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,01,cc */
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},        /* 00,02,10,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},        /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},        /* 00,06,e0,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},        /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},        /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},        /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},        /* 01,1c,00,cc */
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},        /* 00,9c,e8,cc */
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},        /* 00,9e,88,cc */
        {0xa0, 0x98, ZC3XX_R08B_I2CDEVICEADDR},        /* 00,8b,98,cc */
        {0xaa, 0x13, 0x0000},        /* 00,13,00,aa */
        {0xaa, 0x15, 0x0001},        /* 00,15,01,aa */
        {0xaa, 0x01, 0x0000},        /* 00,01,00,aa */
        {0xaa, 0x02, 0x0000},        /* 00,02,00,aa */
        {0xaa, 0x1a, 0x0000},        /* 00,1a,00,aa */
        {0xaa, 0x1c, 0x0017},        /* 00,1c,17,aa */
        {0xaa, 0x1d, 0x0080},        /* 00,1d,80,aa */
        {0xaa, 0x1f, 0x0008},        /* 00,1f,08,aa */
        {0xaa, 0x21, 0x0012},        /* 00,21,12,aa */
        {0xa0, 0x82, ZC3XX_R086_EXPTIMEHIGH},        /* 00,86,82,cc */
        {0xa0, 0x83, ZC3XX_R087_EXPTIMEMID},        /* 00,87,83,cc */
        {0xa0, 0x84, ZC3XX_R088_EXPTIMELOW},        /* 00,88,84,cc */
        {0xaa, 0x05, 0x0000},        /* 00,05,00,aa */
        {0xaa, 0x0a, 0x0000},        /* 00,0a,00,aa */
        {0xaa, 0x0b, 0x00b0},        /* 00,0b,b0,aa */
        {0xaa, 0x0c, 0x0000},        /* 00,0c,00,aa */
        {0xaa, 0x0d, 0x00b0},        /* 00,0d,b0,aa */
        {0xaa, 0x0e, 0x0000},        /* 00,0e,00,aa */
        {0xaa, 0x0f, 0x00b0},        /* 00,0f,b0,aa */
        {0xaa, 0x10, 0x0000},        /* 00,10,00,aa */
        {0xaa, 0x11, 0x00b0},        /* 00,11,b0,aa */
        {0xaa, 0x16, 0x0001},        /* 00,16,01,aa */
        {0xaa, 0x17, 0x00e8},        /* 00,17,e8,aa */
        {0xaa, 0x18, 0x0002},        /* 00,18,02,aa */
        {0xaa, 0x19, 0x0088},        /* 00,19,88,aa */
        {0xaa, 0x20, 0x0000},        /* 00,20,00,aa */
        {0xaa, 0x1b, 0x0020},        /* 00,1b,20,aa */
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,b7,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,05,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},        /* 01,00,0d,cc */
        {0xa0, 0x76, ZC3XX_R189_AWBSTATUS},        /* 01,89,76,cc */
        {0xa0, 0x09, 0x01ad},        /* 01,ad,09,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},        /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},        /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},        /* 03,01,08,cc */
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},        /* 01,a8,60,cc */
        {0xa0, 0x00, 0x011e},        /* 01,1e,00,cc */
        {0xa0, 0x52, ZC3XX_R116_RGAIN},        /* 01,16,52,cc */
        {0xa0, 0x40, ZC3XX_R117_GGAIN},        /* 01,17,40,cc */
        {0xa0, 0x52, ZC3XX_R118_BGAIN},        /* 01,18,52,cc */
        {0xa0, 0x03, ZC3XX_R113_RGB03},        /* 01,13,03,cc */
        {}
};
static const struct usb_action gc0305_50HZ[] = {
        {0xaa, 0x82, 0x0000},        /* 00,82,00,aa */
        {0xaa, 0x83, 0x0002},        /* 00,83,02,aa */
        {0xaa, 0x84, 0x0038},        /* 00,84,38,aa */        /* win: 00,84,ec */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x0b, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,0b,cc */
        {0xa0, 0x18, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,18,cc */
                                                        /* win: 01,92,10 */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x8e, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,8e,cc */
                                                        /* win: 01,97,ec */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},        /* 01,8c,0e,cc */
        {0xa0, 0x15, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,15,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,10,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x62, ZC3XX_R01D_HSYNC_0},        /* 00,1d,62,cc */
        {0xa0, 0x90, ZC3XX_R01E_HSYNC_1},        /* 00,1e,90,cc */
        {0xa0, 0xc8, ZC3XX_R01F_HSYNC_2},        /* 00,1f,c8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},        /* 00,20,ff,cc */
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},        /* 01,1d,60,cc */
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},        /* 01,80,42,cc */
/*        {0xa0, 0x85, ZC3XX_R18D_YTARGET},         * 01,8d,85,cc *
                                                 * if 640x480 */
        {}
};
static const struct usb_action gc0305_60HZ[] = {
        {0xaa, 0x82, 0x0000},        /* 00,82,00,aa */
        {0xaa, 0x83, 0x0000},        /* 00,83,00,aa */
        {0xaa, 0x84, 0x00ec},        /* 00,84,ec,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x0b, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,0b,cc */
        {0xa0, 0x10, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,10,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0xec, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,ec,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},        /* 01,8c,0e,cc */
        {0xa0, 0x15, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,15,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,10,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x62, ZC3XX_R01D_HSYNC_0},        /* 00,1d,62,cc */
        {0xa0, 0x90, ZC3XX_R01E_HSYNC_1},        /* 00,1e,90,cc */
        {0xa0, 0xc8, ZC3XX_R01F_HSYNC_2},        /* 00,1f,c8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},        /* 00,20,ff,cc */
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},        /* 01,1d,60,cc */
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},        /* 01,80,42,cc */
        {0xa0, 0x80, ZC3XX_R18D_YTARGET},        /* 01,8d,80,cc */
        {}
};

static const struct usb_action gc0305_NoFlicker[] = {
        {0xa0, 0x0c, ZC3XX_R100_OPERATIONMODE},        /* 01,00,0c,cc */
        {0xaa, 0x82, 0x0000},        /* 00,82,00,aa */
        {0xaa, 0x83, 0x0000},        /* 00,83,00,aa */
        {0xaa, 0x84, 0x0020},        /* 00,84,20,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x00, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,00,cc */
        {0xa0, 0x48, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,48,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x10, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,10,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},        /* 01,8c,0e,cc */
        {0xa0, 0x15, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,15,cc */
        {0xa0, 0x62, ZC3XX_R01D_HSYNC_0},        /* 00,1d,62,cc */
        {0xa0, 0x90, ZC3XX_R01E_HSYNC_1},        /* 00,1e,90,cc */
        {0xa0, 0xc8, ZC3XX_R01F_HSYNC_2},        /* 00,1f,c8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},        /* 00,20,ff,cc */
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},        /* 01,1d,60,cc */
        {0xa0, 0x03, ZC3XX_R180_AUTOCORRECTENABLE},        /* 01,80,03,cc */
        {0xa0, 0x80, ZC3XX_R18D_YTARGET},        /* 01,8d,80,cc */
        {}
};

static const struct usb_action hdcs2020_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x11, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* qtable 0x05 */
        {0xa0, 0x08, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xaa, 0x1c, 0x0000},
        {0xaa, 0x0a, 0x0001},
        {0xaa, 0x0b, 0x0006},
        {0xaa, 0x0c, 0x007b},
        {0xaa, 0x0d, 0x00a7},
        {0xaa, 0x03, 0x00fb},
        {0xaa, 0x05, 0x0000},
        {0xaa, 0x06, 0x0003},
        {0xaa, 0x09, 0x0008},

        {0xaa, 0x0f, 0x0018},        /* set sensor gain */
        {0xaa, 0x10, 0x0018},
        {0xaa, 0x11, 0x0018},
        {0xaa, 0x12, 0x0018},

        {0xaa, 0x15, 0x004e},
        {0xaa, 0x1c, 0x0004},
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x70, ZC3XX_R18D_YTARGET},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa1, 0x01, 0x0002},
        {0xa1, 0x01, 0x0008},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {0xa1, 0x01, 0x0008},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x13, ZC3XX_R120_GAMMA00},        /* gamma 4 */
        {0xa0, 0x38, ZC3XX_R121_GAMMA01},
        {0xa0, 0x59, ZC3XX_R122_GAMMA02},
        {0xa0, 0x79, ZC3XX_R123_GAMMA03},
        {0xa0, 0x92, ZC3XX_R124_GAMMA04},
        {0xa0, 0xa7, ZC3XX_R125_GAMMA05},
        {0xa0, 0xb9, ZC3XX_R126_GAMMA06},
        {0xa0, 0xc8, ZC3XX_R127_GAMMA07},
        {0xa0, 0xd4, ZC3XX_R128_GAMMA08},
        {0xa0, 0xdf, ZC3XX_R129_GAMMA09},
        {0xa0, 0xe7, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xee, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xf4, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xf9, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xfc, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x26, ZC3XX_R130_GAMMA10},
        {0xa0, 0x22, ZC3XX_R131_GAMMA11},
        {0xa0, 0x20, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1c, ZC3XX_R133_GAMMA13},
        {0xa0, 0x16, ZC3XX_R134_GAMMA14},
        {0xa0, 0x13, ZC3XX_R135_GAMMA15},
        {0xa0, 0x10, ZC3XX_R136_GAMMA16},
        {0xa0, 0x0d, ZC3XX_R137_GAMMA17},
        {0xa0, 0x0b, ZC3XX_R138_GAMMA18},
        {0xa0, 0x09, ZC3XX_R139_GAMMA19},
        {0xa0, 0x07, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x06, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x05, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x04, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x03, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x02, ZC3XX_R13F_GAMMA1F},

        {0xa0, 0x66, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xed, ZC3XX_R10B_RGB01},
        {0xa0, 0xed, ZC3XX_R10C_RGB02},
        {0xa0, 0xed, ZC3XX_R10D_RGB10},
        {0xa0, 0x66, ZC3XX_R10E_RGB11},
        {0xa0, 0xed, ZC3XX_R10F_RGB12},
        {0xa0, 0xed, ZC3XX_R110_RGB20},
        {0xa0, 0xed, ZC3XX_R111_RGB21},
        {0xa0, 0x66, ZC3XX_R112_RGB22},

        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x13, 0x0031},
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x0e, 0x0004},
        {0xaa, 0x19, 0x00cd},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x62, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x3d, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},

        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 0x14 */
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x18, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x2c, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x41, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action hdcs2020_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xaa, 0x1c, 0x0000},
        {0xaa, 0x0a, 0x0001},
        {0xaa, 0x0b, 0x0006},
        {0xaa, 0x0c, 0x007a},
        {0xaa, 0x0d, 0x00a7},
        {0xaa, 0x03, 0x00fb},
        {0xaa, 0x05, 0x0000},
        {0xaa, 0x06, 0x0003},
        {0xaa, 0x09, 0x0008},
        {0xaa, 0x0f, 0x0018},        /* original setting */
        {0xaa, 0x10, 0x0018},
        {0xaa, 0x11, 0x0018},
        {0xaa, 0x12, 0x0018},
        {0xaa, 0x15, 0x004e},
        {0xaa, 0x1c, 0x0004},
        {0xa0, 0xf7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x70, ZC3XX_R18D_YTARGET},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa1, 0x01, 0x0002},
        {0xa1, 0x01, 0x0008},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {0xa1, 0x01, 0x0008},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x13, ZC3XX_R120_GAMMA00},        /* gamma 4 */
        {0xa0, 0x38, ZC3XX_R121_GAMMA01},
        {0xa0, 0x59, ZC3XX_R122_GAMMA02},
        {0xa0, 0x79, ZC3XX_R123_GAMMA03},
        {0xa0, 0x92, ZC3XX_R124_GAMMA04},
        {0xa0, 0xa7, ZC3XX_R125_GAMMA05},
        {0xa0, 0xb9, ZC3XX_R126_GAMMA06},
        {0xa0, 0xc8, ZC3XX_R127_GAMMA07},
        {0xa0, 0xd4, ZC3XX_R128_GAMMA08},
        {0xa0, 0xdf, ZC3XX_R129_GAMMA09},
        {0xa0, 0xe7, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xee, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xf4, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xf9, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xfc, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x26, ZC3XX_R130_GAMMA10},
        {0xa0, 0x22, ZC3XX_R131_GAMMA11},
        {0xa0, 0x20, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1c, ZC3XX_R133_GAMMA13},
        {0xa0, 0x16, ZC3XX_R134_GAMMA14},
        {0xa0, 0x13, ZC3XX_R135_GAMMA15},
        {0xa0, 0x10, ZC3XX_R136_GAMMA16},
        {0xa0, 0x0d, ZC3XX_R137_GAMMA17},
        {0xa0, 0x0b, ZC3XX_R138_GAMMA18},
        {0xa0, 0x09, ZC3XX_R139_GAMMA19},
        {0xa0, 0x07, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x06, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x05, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x04, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x03, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x02, ZC3XX_R13F_GAMMA1F},
        {0xa0, 0x66, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xed, ZC3XX_R10B_RGB01},
        {0xa0, 0xed, ZC3XX_R10C_RGB02},
        {0xa0, 0xed, ZC3XX_R10D_RGB10},
        {0xa0, 0x66, ZC3XX_R10E_RGB11},
        {0xa0, 0xed, ZC3XX_R10F_RGB12},
        {0xa0, 0xed, ZC3XX_R110_RGB20},
        {0xa0, 0xed, ZC3XX_R111_RGB21},
        {0xa0, 0x66, ZC3XX_R112_RGB22},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
 /**** set exposure ***/
        {0xaa, 0x13, 0x0031},
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x0e, 0x0004},
        {0xaa, 0x19, 0x00cd},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x62, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x3d, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x18, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x2c, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x41, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action hdcs2020_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x13, 0x0018},                        /* 00,13,18,aa */
        {0xaa, 0x14, 0x0001},                        /* 00,14,01,aa */
        {0xaa, 0x0e, 0x0005},                        /* 00,0e,05,aa */
        {0xaa, 0x19, 0x001f},                        /* 00,19,1f,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,02,cc */
        {0xa0, 0x76, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,76,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x46, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,46,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,0c,cc */
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,28,cc */
        {0xa0, 0x05, ZC3XX_R01D_HSYNC_0}, /* 00,1d,05,cc */
        {0xa0, 0x1a, ZC3XX_R01E_HSYNC_1}, /* 00,1e,1a,cc */
        {0xa0, 0x2f, ZC3XX_R01F_HSYNC_2}, /* 00,1f,2f,cc */
        {}
};
static const struct usb_action hdcs2020_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x13, 0x0031},                        /* 00,13,31,aa */
        {0xaa, 0x14, 0x0001},                        /* 00,14,01,aa */
        {0xaa, 0x0e, 0x0004},                        /* 00,0e,04,aa */
        {0xaa, 0x19, 0x00cd},                        /* 00,19,cd,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,02,cc */
        {0xa0, 0x62, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,62,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x3d, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,3d,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x0c, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,0c,cc */
        {0xa0, 0x28, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,28,cc */
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0}, /* 00,1d,04,cc */
        {0xa0, 0x18, ZC3XX_R01E_HSYNC_1}, /* 00,1e,18,cc */
        {0xa0, 0x2c, ZC3XX_R01F_HSYNC_2}, /* 00,1f,2c,cc */
        {}
};
static const struct usb_action hdcs2020_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x13, 0x0010},                        /* 00,13,10,aa */
        {0xaa, 0x14, 0x0001},                        /* 00,14,01,aa */
        {0xaa, 0x0e, 0x0004},                        /* 00,0e,04,aa */
        {0xaa, 0x19, 0x0000},                        /* 00,19,00,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,02,cc */
        {0xa0, 0x70, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,70,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x10, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,10,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,00,cc */
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,00,cc */
        {0xa0, 0x04, ZC3XX_R01D_HSYNC_0}, /* 00,1d,04,cc */
        {0xa0, 0x17, ZC3XX_R01E_HSYNC_1}, /* 00,1e,17,cc */
        {0xa0, 0x2a, ZC3XX_R01F_HSYNC_2}, /* 00,1f,2a,cc */
        {}
};

static const struct usb_action hv7131b_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x00, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xaa, 0x30, 0x002d},
        {0xaa, 0x01, 0x0005},
        {0xaa, 0x11, 0x0000},
        {0xaa, 0x13, 0x0001},        /* {0xaa, 0x13, 0x0000}, */
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x15, 0x00e8},
        {0xaa, 0x16, 0x0002},
        {0xaa, 0x17, 0x0086},                /* 00,17,88,aa */
        {0xaa, 0x31, 0x0038},
        {0xaa, 0x32, 0x0038},
        {0xaa, 0x33, 0x0038},
        {0xaa, 0x5b, 0x0001},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x68, ZC3XX_R18D_YTARGET},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0xc0, 0x019b},
        {0xa0, 0xa0, 0x019c},
        {0xa0, 0x02, ZC3XX_R188_MINGAIN},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xaa, 0x02, 0x0090},                        /* 00,02,80,aa */
        {}
};

static const struct usb_action hv7131b_Initial[] = {        /* 640x480*/
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x00, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xaa, 0x30, 0x002d},
        {0xaa, 0x01, 0x0005},
        {0xaa, 0x11, 0x0001},
        {0xaa, 0x13, 0x0000},        /* {0xaa, 0x13, 0x0001}; */
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x15, 0x00e6},
        {0xaa, 0x16, 0x0002},
        {0xaa, 0x17, 0x0086},
        {0xaa, 0x31, 0x0038},
        {0xaa, 0x32, 0x0038},
        {0xaa, 0x33, 0x0038},
        {0xaa, 0x5b, 0x0001},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x70, ZC3XX_R18D_YTARGET},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0xc0, 0x019b},
        {0xa0, 0xa0, 0x019c},
        {0xa0, 0x02, ZC3XX_R188_MINGAIN},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xaa, 0x02, 0x0090},        /* {0xaa, 0x02, 0x0080}, */
        {}
};
static const struct usb_action hv7131b_50HZ[] = {        /* 640x480*/
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0007},                        /* 00,25,07,aa */
        {0xaa, 0x26, 0x0053},                        /* 00,26,53,aa */
        {0xaa, 0x27, 0x0000},                        /* 00,27,00,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x0050},                        /* 00,21,50,aa */
        {0xaa, 0x22, 0x001b},                        /* 00,22,1b,aa */
        {0xaa, 0x23, 0x00fc},                        /* 00,23,fc,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0x9b, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,9b,cc */
        {0xa0, 0x80, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,80,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0xea, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,ea,cc */
        {0xa0, 0x60, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,60,cc */
        {0xa0, 0x0c, ZC3XX_R18C_AEFREEZE},        /* 01,8c,0c,cc */
        {0xa0, 0x18, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,18,cc */
        {0xa0, 0x18, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,18,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0x50, ZC3XX_R01E_HSYNC_1},        /* 00,1e,50,cc */
        {0xa0, 0x1b, ZC3XX_R01F_HSYNC_2},        /* 00,1f,1b,cc */
        {0xa0, 0xfc, ZC3XX_R020_HSYNC_3},        /* 00,20,fc,cc */
        {}
};
static const struct usb_action hv7131b_50HZScale[] = {        /* 320x240 */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0007},                        /* 00,25,07,aa */
        {0xaa, 0x26, 0x0053},                        /* 00,26,53,aa */
        {0xaa, 0x27, 0x0000},                        /* 00,27,00,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x0050},                        /* 00,21,50,aa */
        {0xaa, 0x22, 0x0012},                        /* 00,22,12,aa */
        {0xaa, 0x23, 0x0080},                        /* 00,23,80,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0x9b, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,9b,cc */
        {0xa0, 0x80, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,80,cc */
        {0xa0, 0x01, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,01,cc */
        {0xa0, 0xd4, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,d4,cc */
        {0xa0, 0xc0, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,c0,cc */
        {0xa0, 0x07, ZC3XX_R18C_AEFREEZE},        /* 01,8c,07,cc */
        {0xa0, 0x0f, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,0f,cc */
        {0xa0, 0x18, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,18,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0x50, ZC3XX_R01E_HSYNC_1},        /* 00,1e,50,cc */
        {0xa0, 0x12, ZC3XX_R01F_HSYNC_2},        /* 00,1f,12,cc */
        {0xa0, 0x80, ZC3XX_R020_HSYNC_3},        /* 00,20,80,cc */
        {}
};
static const struct usb_action hv7131b_60HZ[] = {        /* 640x480*/
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0007},                        /* 00,25,07,aa */
        {0xaa, 0x26, 0x00a1},                        /* 00,26,a1,aa */
        {0xaa, 0x27, 0x0020},                        /* 00,27,20,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x0040},                        /* 00,21,40,aa */
        {0xaa, 0x22, 0x0013},                        /* 00,22,13,aa */
        {0xaa, 0x23, 0x004c},                        /* 00,23,4c,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0x4d, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,4d,cc */
        {0xa0, 0x60, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,60,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0xc3, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,c3,cc */
        {0xa0, 0x50, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,50,cc */
        {0xa0, 0x0c, ZC3XX_R18C_AEFREEZE},        /* 01,8c,0c,cc */
        {0xa0, 0x18, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,18,cc */
        {0xa0, 0x18, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,18,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0x40, ZC3XX_R01E_HSYNC_1},        /* 00,1e,40,cc */
        {0xa0, 0x13, ZC3XX_R01F_HSYNC_2},        /* 00,1f,13,cc */
        {0xa0, 0x4c, ZC3XX_R020_HSYNC_3},        /* 00,20,4c,cc */
        {}
};
static const struct usb_action hv7131b_60HZScale[] = {        /* 320x240 */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0007},                        /* 00,25,07,aa */
        {0xaa, 0x26, 0x00a1},                        /* 00,26,a1,aa */
        {0xaa, 0x27, 0x0020},                        /* 00,27,20,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x00a0},                        /* 00,21,a0,aa */
        {0xaa, 0x22, 0x0016},                        /* 00,22,16,aa */
        {0xaa, 0x23, 0x0040},                        /* 00,23,40,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0x4d, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,4d,cc */
        {0xa0, 0x60, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,60,cc */
        {0xa0, 0x01, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,01,cc */
        {0xa0, 0x86, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,86,cc */
        {0xa0, 0xa0, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,a0,cc */
        {0xa0, 0x07, ZC3XX_R18C_AEFREEZE},        /* 01,8c,07,cc */
        {0xa0, 0x0f, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,0f,cc */
        {0xa0, 0x18, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,18,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0xa0, ZC3XX_R01E_HSYNC_1},        /* 00,1e,a0,cc */
        {0xa0, 0x16, ZC3XX_R01F_HSYNC_2},        /* 00,1f,16,cc */
        {0xa0, 0x40, ZC3XX_R020_HSYNC_3},        /* 00,20,40,cc */
        {}
};
static const struct usb_action hv7131b_NoFlicker[] = {        /* 640x480*/
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0003},                        /* 00,25,03,aa */
        {0xaa, 0x26, 0x0000},                        /* 00,26,00,aa */
        {0xaa, 0x27, 0x0000},                        /* 00,27,00,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x0010},                        /* 00,21,10,aa */
        {0xaa, 0x22, 0x0000},                        /* 00,22,00,aa */
        {0xaa, 0x23, 0x0003},                        /* 00,23,03,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0xf8, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,f8,cc */
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,00,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x02, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,02,cc */
        {0xa0, 0x00, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,00,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},        /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,00,cc */
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,00,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0x10, ZC3XX_R01E_HSYNC_1},        /* 00,1e,10,cc */
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},        /* 00,1f,00,cc */
        {0xa0, 0x03, ZC3XX_R020_HSYNC_3},        /* 00,20,03,cc */
        {}
};
static const struct usb_action hv7131b_NoFlickerScale[] = { /* 320x240 */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},        /* 00,19,00,cc */
        {0xaa, 0x25, 0x0003},                        /* 00,25,03,aa */
        {0xaa, 0x26, 0x0000},                        /* 00,26,00,aa */
        {0xaa, 0x27, 0x0000},                        /* 00,27,00,aa */
        {0xaa, 0x20, 0x0000},                        /* 00,20,00,aa */
        {0xaa, 0x21, 0x00a0},                        /* 00,21,a0,aa */
        {0xaa, 0x22, 0x0016},                        /* 00,22,16,aa */
        {0xaa, 0x23, 0x0040},                        /* 00,23,40,aa */
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,2f,cc */
        {0xa0, 0xf8, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,f8,cc */
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,00,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x02, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,02,cc */
        {0xa0, 0x00, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,00,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},        /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,00,cc */
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,00,cc */
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},        /* 00,1d,00,cc */
        {0xa0, 0xa0, ZC3XX_R01E_HSYNC_1},        /* 00,1e,a0,cc */
        {0xa0, 0x16, ZC3XX_R01F_HSYNC_2},        /* 00,1f,16,cc */
        {0xa0, 0x40, ZC3XX_R020_HSYNC_3},        /* 00,20,40,cc */
        {}
};

/* from lPEPI264v.inf (hv7131b!) */
static const struct usb_action hv7131r_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x000c},
        {0xaa, 0x11, 0x0000},
        {0xaa, 0x13, 0x0000},
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x15, 0x00e8},
        {0xaa, 0x16, 0x0002},
        {0xaa, 0x17, 0x0088},
        {0xaa, 0x30, 0x000b},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},
        {0xa0, 0x50, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0xc0, 0x019b},
        {0xa0, 0xa0, 0x019c},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {}
};
static const struct usb_action hv7131r_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},
        {0xa0, 0xe6, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x000c},
        {0xaa, 0x11, 0x0000},
        {0xaa, 0x13, 0x0000},
        {0xaa, 0x14, 0x0001},
        {0xaa, 0x15, 0x00e6},
        {0xaa, 0x16, 0x0002},
        {0xaa, 0x17, 0x0086},
        {0xaa, 0x30, 0x000b},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},
        {0xa0, 0x50, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0xc0, 0x019b},
        {0xa0, 0xa0, 0x019c},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {}
};
static const struct usb_action hv7131r_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x06, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x68, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xa0, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0xea, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x60, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x18, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action hv7131r_50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x0c, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xd1, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x40, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x01, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0xd4, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0xc0, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x18, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action hv7131r_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x06, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x1a, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x80, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0xc3, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x50, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x18, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action hv7131r_60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x0c, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x35, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x01, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x86, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0xa0, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x18, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action hv7131r_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xf8, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x02, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x58, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0c, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x18, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};
static const struct usb_action hv7131r_NoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xa0, 0x2f, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0xf8, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x04, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0xb0, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0c, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x18, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x00, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd0, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x00, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0x08, ZC3XX_R020_HSYNC_3},
        {}
};

static const struct usb_action icm105a_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0c, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x00, ZC3XX_R097_WINYSTARTHIGH},
        {0xa0, 0x01, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R099_WINXSTARTHIGH},
        {0xa0, 0x01, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x01, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x01, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xaa, 0x01, 0x0010},
        {0xaa, 0x03, 0x0000},
        {0xaa, 0x04, 0x0001},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0001},
        {0xaa, 0x04, 0x0011},
        {0xaa, 0x05, 0x00a0},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0002},
        {0xaa, 0x04, 0x0013},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0003},
        {0xaa, 0x04, 0x0015},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0004},
        {0xaa, 0x04, 0x0017},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x000d},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0005},
        {0xaa, 0x04, 0x0019},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0006},
        {0xaa, 0x04, 0x0017},
        {0xaa, 0x05, 0x0026},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0007},
        {0xaa, 0x04, 0x0019},
        {0xaa, 0x05, 0x0022},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0008},
        {0xaa, 0x04, 0x0021},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0009},
        {0xaa, 0x04, 0x0023},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x000d},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000a},
        {0xaa, 0x04, 0x0025},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000b},
        {0xaa, 0x04, 0x00ec},
        {0xaa, 0x05, 0x002e},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000c},
        {0xaa, 0x04, 0x00fa},
        {0xaa, 0x05, 0x002a},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x07, 0x000d},
        {0xaa, 0x01, 0x0005},
        {0xaa, 0x94, 0x0002},
        {0xaa, 0x90, 0x0000},
        {0xaa, 0x91, 0x001f},
        {0xaa, 0x10, 0x0064},
        {0xaa, 0x9b, 0x00f0},
        {0xaa, 0x9c, 0x0002},
        {0xaa, 0x14, 0x001a},
        {0xaa, 0x20, 0x0080},
        {0xaa, 0x22, 0x0080},
        {0xaa, 0x24, 0x0080},
        {0xaa, 0x26, 0x0080},
        {0xaa, 0x00, 0x0084},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xaa, 0xa8, 0x00c0},
        {0xa1, 0x01, 0x0002},
        {0xa1, 0x01, 0x0008},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {0xa1, 0x01, 0x0008},

        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x52, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf7, ZC3XX_R10B_RGB01},
        {0xa0, 0xf7, ZC3XX_R10C_RGB02},
        {0xa0, 0xf7, ZC3XX_R10D_RGB10},
        {0xa0, 0x52, ZC3XX_R10E_RGB11},
        {0xa0, 0xf7, ZC3XX_R10F_RGB12},
        {0xa0, 0xf7, ZC3XX_R110_RGB20},
        {0xa0, 0xf7, ZC3XX_R111_RGB21},
        {0xa0, 0x52, ZC3XX_R112_RGB22},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x0d, 0x0003},
        {0xaa, 0x0c, 0x008c},
        {0xaa, 0x0e, 0x0095},
        {0xaa, 0x0f, 0x0002},
        {0xaa, 0x1c, 0x0094},
        {0xaa, 0x1d, 0x0002},
        {0xaa, 0x20, 0x0080},
        {0xaa, 0x22, 0x0080},
        {0xaa, 0x24, 0x0080},
        {0xaa, 0x26, 0x0080},
        {0xaa, 0x00, 0x0084},
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH},
        {0xa0, 0x94, ZC3XX_R0A4_EXPOSURETIMELOW},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x20, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x84, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xe3, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xec, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf5, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0xc0, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0xc0, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {}
};

static const struct usb_action icm105a_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0c, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x00, ZC3XX_R097_WINYSTARTHIGH},
        {0xa0, 0x02, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R099_WINXSTARTHIGH},
        {0xa0, 0x02, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x02, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x02, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},
        {0xa0, 0xe6, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xaa, 0x01, 0x0010},
        {0xaa, 0x03, 0x0000},
        {0xaa, 0x04, 0x0001},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0001},
        {0xaa, 0x04, 0x0011},
        {0xaa, 0x05, 0x00a0},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0002},
        {0xaa, 0x04, 0x0013},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0001},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0003},
        {0xaa, 0x04, 0x0015},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0004},
        {0xaa, 0x04, 0x0017},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x000d},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0005},
        {0xa0, 0x04, ZC3XX_R092_I2CADDRESSSELECT},
        {0xa0, 0x19, ZC3XX_R093_I2CSETVALUE},
        {0xa0, 0x01, ZC3XX_R090_I2CCOMMAND},
        {0xa1, 0x01, 0x0091},
        {0xaa, 0x05, 0x0020},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0006},
        {0xaa, 0x04, 0x0017},
        {0xaa, 0x05, 0x0026},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0007},
        {0xaa, 0x04, 0x0019},
        {0xaa, 0x05, 0x0022},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0008},
        {0xaa, 0x04, 0x0021},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x0009},
        {0xaa, 0x04, 0x0023},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x000d},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000a},
        {0xaa, 0x04, 0x0025},
        {0xaa, 0x05, 0x00aa},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000b},
        {0xaa, 0x04, 0x00ec},
        {0xaa, 0x05, 0x002e},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x03, 0x000c},
        {0xaa, 0x04, 0x00fa},
        {0xaa, 0x05, 0x002a},
        {0xaa, 0x06, 0x0005},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x07, 0x000d},
        {0xaa, 0x01, 0x0005},
        {0xaa, 0x94, 0x0002},
        {0xaa, 0x90, 0x0000},
        {0xaa, 0x91, 0x0010},
        {0xaa, 0x10, 0x0064},
        {0xaa, 0x9b, 0x00f0},
        {0xaa, 0x9c, 0x0002},
        {0xaa, 0x14, 0x001a},
        {0xaa, 0x20, 0x0080},
        {0xaa, 0x22, 0x0080},
        {0xaa, 0x24, 0x0080},
        {0xaa, 0x26, 0x0080},
        {0xaa, 0x00, 0x0084},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xaa, 0xa8, 0x0080},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},
        {0xa1, 0x01, 0x0002},
        {0xa1, 0x01, 0x0008},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {0xa1, 0x01, 0x0008},

        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */

        {0xa0, 0x52, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf7, ZC3XX_R10B_RGB01},
        {0xa0, 0xf7, ZC3XX_R10C_RGB02},
        {0xa0, 0xf7, ZC3XX_R10D_RGB10},
        {0xa0, 0x52, ZC3XX_R10E_RGB11},
        {0xa0, 0xf7, ZC3XX_R10F_RGB12},
        {0xa0, 0xf7, ZC3XX_R110_RGB20},
        {0xa0, 0xf7, ZC3XX_R111_RGB21},
        {0xa0, 0x52, ZC3XX_R112_RGB22},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x0d, 0x0003},
        {0xaa, 0x0c, 0x0020},
        {0xaa, 0x0e, 0x000e},
        {0xaa, 0x0f, 0x0002},
        {0xaa, 0x1c, 0x000d},
        {0xaa, 0x1d, 0x0002},
        {0xaa, 0x20, 0x0080},
        {0xaa, 0x22, 0x0080},
        {0xaa, 0x24, 0x0080},
        {0xaa, 0x26, 0x0080},
        {0xaa, 0x00, 0x0084},
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH},
        {0xa0, 0x0d, ZC3XX_R0A4_EXPOSURETIMELOW},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x1a, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x4b, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xc8, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xd8, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xea, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action icm105a_50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x0020}, /* 00,0c,20,aa */
        {0xaa, 0x0e, 0x000e}, /* 00,0e,0e,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x000d}, /* 00,1c,0d,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x0d, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,0d,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x1a, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,1a,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x4b, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,4b,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,10,cc */
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,12,cc */
        {0xa0, 0xc8, ZC3XX_R01D_HSYNC_0}, /* 00,1d,c8,cc */
        {0xa0, 0xd8, ZC3XX_R01E_HSYNC_1}, /* 00,1e,d8,cc */
        {0xa0, 0xea, ZC3XX_R01F_HSYNC_2}, /* 00,1f,ea,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {}
};
static const struct usb_action icm105a_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x008c}, /* 00,0c,8c,aa */
        {0xaa, 0x0e, 0x0095}, /* 00,0e,95,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x0094}, /* 00,1c,94,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x94, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,94,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x20, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,20,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x84, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,84,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,10,cc */
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,12,cc */
        {0xa0, 0xe3, ZC3XX_R01D_HSYNC_0}, /* 00,1d,e3,cc */
        {0xa0, 0xec, ZC3XX_R01E_HSYNC_1}, /* 00,1e,ec,cc */
        {0xa0, 0xf5, ZC3XX_R01F_HSYNC_2}, /* 00,1f,f5,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN}, /* 01,a7,00,cc */
        {0xa0, 0xc0, ZC3XX_R1A8_DIGITALGAIN}, /* 01,a8,c0,cc */
        {}
};
static const struct usb_action icm105a_60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x0004}, /* 00,0c,04,aa */
        {0xaa, 0x0e, 0x000d}, /* 00,0e,0d,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x0008}, /* 00,1c,08,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x08, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,08,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x10, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,10,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x41, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,41,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,10,cc */
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,12,cc */
        {0xa0, 0xc1, ZC3XX_R01D_HSYNC_0}, /* 00,1d,c1,cc */
        {0xa0, 0xd4, ZC3XX_R01E_HSYNC_1}, /* 00,1e,d4,cc */
        {0xa0, 0xe8, ZC3XX_R01F_HSYNC_2}, /* 00,1f,e8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {}
};
static const struct usb_action icm105a_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x0008}, /* 00,0c,08,aa */
        {0xaa, 0x0e, 0x0086}, /* 00,0e,86,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x0085}, /* 00,1c,85,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x85, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,85,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x08, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,08,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x81, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,81,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,10,cc */
        {0xa0, 0x12, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,12,cc */
        {0xa0, 0xc2, ZC3XX_R01D_HSYNC_0}, /* 00,1d,c2,cc */
        {0xa0, 0xd6, ZC3XX_R01E_HSYNC_1}, /* 00,1e,d6,cc */
        {0xa0, 0xea, ZC3XX_R01F_HSYNC_2}, /* 00,1f,ea,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN}, /* 01,a7,00,cc */
        {0xa0, 0xc0, ZC3XX_R1A8_DIGITALGAIN}, /* 01,a8,c0,cc */
        {}
};
static const struct usb_action icm105a_NoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x0004}, /* 00,0c,04,aa */
        {0xaa, 0x0e, 0x000d}, /* 00,0e,0d,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x0000}, /* 00,1c,00,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x00, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,00,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x20, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,20,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x10, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,10,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,00,cc */
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,00,cc */
        {0xa0, 0xc1, ZC3XX_R01D_HSYNC_0}, /* 00,1d,c1,cc */
        {0xa0, 0xd4, ZC3XX_R01E_HSYNC_1}, /* 00,1e,d4,cc */
        {0xa0, 0xe8, ZC3XX_R01F_HSYNC_2}, /* 00,1f,e8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {}
};
static const struct usb_action icm105a_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xaa, 0x0d, 0x0003}, /* 00,0d,03,aa */
        {0xaa, 0x0c, 0x0004}, /* 00,0c,04,aa */
        {0xaa, 0x0e, 0x0081}, /* 00,0e,81,aa */
        {0xaa, 0x0f, 0x0002}, /* 00,0f,02,aa */
        {0xaa, 0x1c, 0x0080}, /* 00,1c,80,aa */
        {0xaa, 0x1d, 0x0002}, /* 00,1d,02,aa */
        {0xaa, 0x20, 0x0080}, /* 00,20,80,aa */
        {0xaa, 0x22, 0x0080}, /* 00,22,80,aa */
        {0xaa, 0x24, 0x0080}, /* 00,24,80,aa */
        {0xaa, 0x26, 0x0080}, /* 00,26,80,aa */
        {0xaa, 0x00, 0x0084}, /* 00,00,84,aa */
        {0xa0, 0x02, ZC3XX_R0A3_EXPOSURETIMEHIGH}, /* 00,a3,02,cc */
        {0xa0, 0x80, ZC3XX_R0A4_EXPOSURETIMELOW}, /* 00,a4,80,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x20, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,20,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x10, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,10,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE}, /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE}, /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,00,cc */
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP}, /* 01,aa,00,cc */
        {0xa0, 0xc1, ZC3XX_R01D_HSYNC_0}, /* 00,1d,c1,cc */
        {0xa0, 0xd4, ZC3XX_R01E_HSYNC_1}, /* 00,1e,d4,cc */
        {0xa0, 0xe8, ZC3XX_R01F_HSYNC_2}, /* 00,1f,e8,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3}, /* 00,20,ff,cc */
        {0xa0, 0x00, ZC3XX_R1A7_CALCGLOBALMEAN}, /* 01,a7,00,cc */
        {0xa0, 0xc0, ZC3XX_R1A8_DIGITALGAIN}, /* 01,a8,c0,cc */
        {}
};

static const struct usb_action mc501cb_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL}, /* 00,00,01,cc */
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT}, /* 00,02,00,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT}, /* 00,10,01,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING}, /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING}, /* 00,08,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,01,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH}, /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW}, /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH}, /* 00,05,01,cc */
        {0xa0, 0xd8, ZC3XX_R006_FRAMEHEIGHTLOW}, /* 00,06,d8,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW}, /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW}, /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW}, /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW}, /* 01,1c,00,cc */
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH}, /* 00,9b,01,cc */
        {0xa0, 0xde, ZC3XX_R09C_WINHEIGHTLOW}, /* 00,9c,de,cc */
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH}, /* 00,9d,02,cc */
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW}, /* 00,9e,86,cc */
        {0xa0, 0x33, ZC3XX_R086_EXPTIMEHIGH}, /* 00,86,33,cc */
        {0xa0, 0x34, ZC3XX_R087_EXPTIMEMID}, /* 00,87,34,cc */
        {0xa0, 0x35, ZC3XX_R088_EXPTIMELOW}, /* 00,88,35,cc */
        {0xa0, 0xb0, ZC3XX_R08B_I2CDEVICEADDR}, /* 00,8b,b0,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xaa, 0x01, 0x0001}, /* 00,01,01,aa */
        {0xaa, 0x01, 0x0003}, /* 00,01,03,aa */
        {0xaa, 0x01, 0x0001}, /* 00,01,01,aa */
        {0xaa, 0x03, 0x0000}, /* 00,03,00,aa */
        {0xaa, 0x10, 0x0000}, /* 00,10,00,aa */
        {0xaa, 0x11, 0x0080}, /* 00,11,80,aa */
        {0xaa, 0x12, 0x0000}, /* 00,12,00,aa */
        {0xaa, 0x13, 0x0000}, /* 00,13,00,aa */
        {0xaa, 0x14, 0x0000}, /* 00,14,00,aa */
        {0xaa, 0x15, 0x0000}, /* 00,15,00,aa */
        {0xaa, 0x16, 0x0000}, /* 00,16,00,aa */
        {0xaa, 0x17, 0x0001}, /* 00,17,01,aa */
        {0xaa, 0x18, 0x00de}, /* 00,18,de,aa */
        {0xaa, 0x19, 0x0002}, /* 00,19,02,aa */
        {0xaa, 0x1a, 0x0086}, /* 00,1a,86,aa */
        {0xaa, 0x20, 0x00a8}, /* 00,20,a8,aa */
        {0xaa, 0x22, 0x0000}, /* 00,22,00,aa */
        {0xaa, 0x23, 0x0000}, /* 00,23,00,aa */
        {0xaa, 0x24, 0x0000}, /* 00,24,00,aa */
        {0xaa, 0x40, 0x0033}, /* 00,40,33,aa */
        {0xaa, 0x41, 0x0077}, /* 00,41,77,aa */
        {0xaa, 0x42, 0x0053}, /* 00,42,53,aa */
        {0xaa, 0x43, 0x00b0}, /* 00,43,b0,aa */
        {0xaa, 0x4b, 0x0001}, /* 00,4b,01,aa */
        {0xaa, 0x72, 0x0020}, /* 00,72,20,aa */
        {0xaa, 0x73, 0x0000}, /* 00,73,00,aa */
        {0xaa, 0x80, 0x0000}, /* 00,80,00,aa */
        {0xaa, 0x85, 0x0050}, /* 00,85,50,aa */
        {0xaa, 0x91, 0x0070}, /* 00,91,70,aa */
        {0xaa, 0x92, 0x0072}, /* 00,92,72,aa */
        {0xaa, 0x03, 0x0001}, /* 00,03,01,aa */
        {0xaa, 0x10, 0x00a0}, /* 00,10,a0,aa */
        {0xaa, 0x11, 0x0001}, /* 00,11,01,aa */
        {0xaa, 0x30, 0x0000}, /* 00,30,00,aa */
        {0xaa, 0x60, 0x0000}, /* 00,60,00,aa */
        {0xaa, 0xa0, 0x001a}, /* 00,a0,1a,aa */
        {0xaa, 0xa1, 0x0000}, /* 00,a1,00,aa */
        {0xaa, 0xa2, 0x003f}, /* 00,a2,3f,aa */
        {0xaa, 0xa3, 0x0028}, /* 00,a3,28,aa */
        {0xaa, 0xa4, 0x0010}, /* 00,a4,10,aa */
        {0xaa, 0xa5, 0x0020}, /* 00,a5,20,aa */
        {0xaa, 0xb1, 0x0044}, /* 00,b1,44,aa */
        {0xaa, 0xd0, 0x0001}, /* 00,d0,01,aa */
        {0xaa, 0xd1, 0x0085}, /* 00,d1,85,aa */
        {0xaa, 0xd2, 0x0080}, /* 00,d2,80,aa */
        {0xaa, 0xd3, 0x0080}, /* 00,d3,80,aa */
        {0xaa, 0xd4, 0x0080}, /* 00,d4,80,aa */
        {0xaa, 0xd5, 0x0080}, /* 00,d5,80,aa */
        {0xaa, 0xc0, 0x00c3}, /* 00,c0,c3,aa */
        {0xaa, 0xc2, 0x0044}, /* 00,c2,44,aa */
        {0xaa, 0xc4, 0x0040}, /* 00,c4,40,aa */
        {0xaa, 0xc5, 0x0020}, /* 00,c5,20,aa */
        {0xaa, 0xc6, 0x0008}, /* 00,c6,08,aa */
        {0xaa, 0x03, 0x0004}, /* 00,03,04,aa */
        {0xaa, 0x10, 0x0000}, /* 00,10,00,aa */
        {0xaa, 0x40, 0x0030}, /* 00,40,30,aa */
        {0xaa, 0x41, 0x0020}, /* 00,41,20,aa */
        {0xaa, 0x42, 0x002d}, /* 00,42,2d,aa */
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x1c, 0x0050}, /* 00,1C,50,aa */
        {0xaa, 0x11, 0x0081}, /* 00,11,81,aa */
        {0xaa, 0x3b, 0x001d}, /* 00,3b,1D,aa */
        {0xaa, 0x3c, 0x004c}, /* 00,3c,4C,aa */
        {0xaa, 0x3d, 0x0018}, /* 00,3d,18,aa */
        {0xaa, 0x3e, 0x006a}, /* 00,3e,6A,aa */
        {0xaa, 0x01, 0x0000}, /* 00,01,00,aa */
        {0xaa, 0x52, 0x00ff}, /* 00,52,FF,aa */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE}, /* 01,00,0d,cc */
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION}, /* 01,01,37,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS}, /* 01,89,06,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE}, /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05}, /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE}, /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS}, /* 03,01,08,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE}, /* 01,80,02,cc */
        {0xaa, 0x03, 0x0002}, /* 00,03,02,aa */
        {0xaa, 0x51, 0x0027}, /* 00,51,27,aa */
        {0xaa, 0x52, 0x0020}, /* 00,52,20,aa */
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x50, 0x0010}, /* 00,50,10,aa */
        {0xaa, 0x51, 0x0010}, /* 00,51,10,aa */
        {0xaa, 0x54, 0x0010}, /* 00,54,10,aa */
        {0xaa, 0x55, 0x0010}, /* 00,55,10,aa */
        {0xa0, 0xf0, 0x0199}, /* 01,99,F0,cc */
        {0xa0, 0x80, 0x019a}, /* 01,9A,80,cc */

        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x001d}, /* 00,36,1D,aa */
        {0xaa, 0x37, 0x004c}, /* 00,37,4C,aa */
        {0xaa, 0x3b, 0x001d}, /* 00,3B,1D,aa */
        {}
};

static const struct usb_action mc501cb_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL}, /* 00,00,01,cc */
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT}, /* 00,02,10,cc */
        {0xa0, 0x01, ZC3XX_R010_CMOSSENSORSELECT}, /* 00,10,01,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING}, /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING}, /* 00,08,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,01,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH}, /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW}, /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH}, /* 00,05,01,cc */
        {0xa0, 0xd0, ZC3XX_R006_FRAMEHEIGHTLOW}, /* 00,06,d0,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW}, /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW}, /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW}, /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW}, /* 01,1c,00,cc */
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH}, /* 00,9b,01,cc */
        {0xa0, 0xd8, ZC3XX_R09C_WINHEIGHTLOW}, /* 00,9c,d8,cc */
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH}, /* 00,9d,02,cc */
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW}, /* 00,9e,88,cc */
        {0xa0, 0x33, ZC3XX_R086_EXPTIMEHIGH}, /* 00,86,33,cc */
        {0xa0, 0x34, ZC3XX_R087_EXPTIMEMID}, /* 00,87,34,cc */
        {0xa0, 0x35, ZC3XX_R088_EXPTIMELOW}, /* 00,88,35,cc */
        {0xa0, 0xb0, ZC3XX_R08B_I2CDEVICEADDR}, /* 00,8b,b0,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xaa, 0x01, 0x0001}, /* 00,01,01,aa */
        {0xaa, 0x01, 0x0003}, /* 00,01,03,aa */
        {0xaa, 0x01, 0x0001}, /* 00,01,01,aa */
        {0xaa, 0x03, 0x0000}, /* 00,03,00,aa */
        {0xaa, 0x10, 0x0000}, /* 00,10,00,aa */
        {0xaa, 0x11, 0x0080}, /* 00,11,80,aa */
        {0xaa, 0x12, 0x0000}, /* 00,12,00,aa */
        {0xaa, 0x13, 0x0000}, /* 00,13,00,aa */
        {0xaa, 0x14, 0x0000}, /* 00,14,00,aa */
        {0xaa, 0x15, 0x0000}, /* 00,15,00,aa */
        {0xaa, 0x16, 0x0000}, /* 00,16,00,aa */
        {0xaa, 0x17, 0x0001}, /* 00,17,01,aa */
        {0xaa, 0x18, 0x00d8}, /* 00,18,d8,aa */
        {0xaa, 0x19, 0x0002}, /* 00,19,02,aa */
        {0xaa, 0x1a, 0x0088}, /* 00,1a,88,aa */
        {0xaa, 0x20, 0x00a8}, /* 00,20,a8,aa */
        {0xaa, 0x22, 0x0000}, /* 00,22,00,aa */
        {0xaa, 0x23, 0x0000}, /* 00,23,00,aa */
        {0xaa, 0x24, 0x0000}, /* 00,24,00,aa */
        {0xaa, 0x40, 0x0033}, /* 00,40,33,aa */
        {0xaa, 0x41, 0x0077}, /* 00,41,77,aa */
        {0xaa, 0x42, 0x0053}, /* 00,42,53,aa */
        {0xaa, 0x43, 0x00b0}, /* 00,43,b0,aa */
        {0xaa, 0x4b, 0x0001}, /* 00,4b,01,aa */
        {0xaa, 0x72, 0x0020}, /* 00,72,20,aa */
        {0xaa, 0x73, 0x0000}, /* 00,73,00,aa */
        {0xaa, 0x80, 0x0000}, /* 00,80,00,aa */
        {0xaa, 0x85, 0x0050}, /* 00,85,50,aa */
        {0xaa, 0x91, 0x0070}, /* 00,91,70,aa */
        {0xaa, 0x92, 0x0072}, /* 00,92,72,aa */
        {0xaa, 0x03, 0x0001}, /* 00,03,01,aa */
        {0xaa, 0x10, 0x00a0}, /* 00,10,a0,aa */
        {0xaa, 0x11, 0x0001}, /* 00,11,01,aa */
        {0xaa, 0x30, 0x0000}, /* 00,30,00,aa */
        {0xaa, 0x60, 0x0000}, /* 00,60,00,aa */
        {0xaa, 0xa0, 0x001a}, /* 00,a0,1a,aa */
        {0xaa, 0xa1, 0x0000}, /* 00,a1,00,aa */
        {0xaa, 0xa2, 0x003f}, /* 00,a2,3f,aa */
        {0xaa, 0xa3, 0x0028}, /* 00,a3,28,aa */
        {0xaa, 0xa4, 0x0010}, /* 00,a4,10,aa */
        {0xaa, 0xa5, 0x0020}, /* 00,a5,20,aa */
        {0xaa, 0xb1, 0x0044}, /* 00,b1,44,aa */
        {0xaa, 0xd0, 0x0001}, /* 00,d0,01,aa */
        {0xaa, 0xd1, 0x0085}, /* 00,d1,85,aa */
        {0xaa, 0xd2, 0x0080}, /* 00,d2,80,aa */
        {0xaa, 0xd3, 0x0080}, /* 00,d3,80,aa */
        {0xaa, 0xd4, 0x0080}, /* 00,d4,80,aa */
        {0xaa, 0xd5, 0x0080}, /* 00,d5,80,aa */
        {0xaa, 0xc0, 0x00c3}, /* 00,c0,c3,aa */
        {0xaa, 0xc2, 0x0044}, /* 00,c2,44,aa */
        {0xaa, 0xc4, 0x0040}, /* 00,c4,40,aa */
        {0xaa, 0xc5, 0x0020}, /* 00,c5,20,aa */
        {0xaa, 0xc6, 0x0008}, /* 00,c6,08,aa */
        {0xaa, 0x03, 0x0004}, /* 00,03,04,aa */
        {0xaa, 0x10, 0x0000}, /* 00,10,00,aa */
        {0xaa, 0x40, 0x0030}, /* 00,40,30,aa */
        {0xaa, 0x41, 0x0020}, /* 00,41,20,aa */
        {0xaa, 0x42, 0x002d}, /* 00,42,2d,aa */
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x1c, 0x0050}, /* 00,1c,50,aa */
        {0xaa, 0x11, 0x0081}, /* 00,11,81,aa */
        {0xaa, 0x3b, 0x003a}, /* 00,3b,3A,aa */
        {0xaa, 0x3c, 0x0098}, /* 00,3c,98,aa */
        {0xaa, 0x3d, 0x0030}, /* 00,3d,30,aa */
        {0xaa, 0x3e, 0x00d4}, /* 00,3E,D4,aa */
        {0xaa, 0x01, 0x0000}, /* 00,01,00,aa */
        {0xaa, 0x52, 0x00ff}, /* 00,52,FF,aa */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS}, /* 00,19,00,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE}, /* 01,00,0d,cc */
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION}, /* 01,01,37,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS}, /* 01,89,06,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE}, /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05}, /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE}, /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS}, /* 03,01,08,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE}, /* 01,80,02,cc */
        {0xaa, 0x03, 0x0002}, /* 00,03,02,aa */
        {0xaa, 0x51, 0x004e}, /* 00,51,4E,aa */
        {0xaa, 0x52, 0x0041}, /* 00,52,41,aa */
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x50, 0x0010}, /* 00,50,10,aa */
        {0xaa, 0x51, 0x0010}, /* 00,51,10,aa */
        {0xaa, 0x54, 0x0010}, /* 00,54,10,aa */
        {0xaa, 0x55, 0x0010}, /* 00,55,10,aa */
        {0xa0, 0xf0, 0x0199}, /* 01,99,F0,cc */
        {0xa0, 0x80, 0x019a}, /* 01,9A,80,cc */
        {}
};

static const struct usb_action mc501cb_50HZ[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x001d}, /* 00,36,1D,aa */
        {0xaa, 0x37, 0x004c}, /* 00,37,4C,aa */
        {0xaa, 0x3b, 0x001d}, /* 00,3B,1D,aa */
        {0xaa, 0x3c, 0x004c}, /* 00,3C,4C,aa */
        {0xaa, 0x3d, 0x001d}, /* 00,3D,1D,aa */
        {0xaa, 0x3e, 0x004c}, /* 00,3E,4C,aa */
        {}
};

static const struct usb_action mc501cb_50HZScale[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x003a}, /* 00,36,3A,aa */
        {0xaa, 0x37, 0x0098}, /* 00,37,98,aa */
        {0xaa, 0x3b, 0x003a}, /* 00,3B,3A,aa */
        {0xaa, 0x3c, 0x0098}, /* 00,3C,98,aa */
        {0xaa, 0x3d, 0x003a}, /* 00,3D,3A,aa */
        {0xaa, 0x3e, 0x0098}, /* 00,3E,98,aa */
        {}
};

static const struct usb_action mc501cb_60HZ[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x0018}, /* 00,36,18,aa */
        {0xaa, 0x37, 0x006a}, /* 00,37,6A,aa */
        {0xaa, 0x3d, 0x0018}, /* 00,3D,18,aa */
        {0xaa, 0x3e, 0x006a}, /* 00,3E,6A,aa */
        {0xaa, 0x3b, 0x0018}, /* 00,3B,18,aa */
        {0xaa, 0x3c, 0x006a}, /* 00,3C,6A,aa */
        {}
};

static const struct usb_action mc501cb_60HZScale[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x0030}, /* 00,36,30,aa */
        {0xaa, 0x37, 0x00d4}, /* 00,37,D4,aa */
        {0xaa, 0x3d, 0x0030}, /* 00,3D,30,aa */
        {0xaa, 0x3e, 0x00d4}, /* 00,3E,D4,aa */
        {0xaa, 0x3b, 0x0030}, /* 00,3B,30,aa */
        {0xaa, 0x3c, 0x00d4}, /* 00,3C,D4,aa */
        {}
};

static const struct usb_action mc501cb_NoFlicker[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x0018}, /* 00,36,18,aa */
        {0xaa, 0x37, 0x006a}, /* 00,37,6A,aa */
        {0xaa, 0x3d, 0x0018}, /* 00,3D,18,aa */
        {0xaa, 0x3e, 0x006a}, /* 00,3E,6A,aa */
        {0xaa, 0x3b, 0x0018}, /* 00,3B,18,aa */
        {0xaa, 0x3c, 0x006a}, /* 00,3C,6A,aa */
        {}
};

static const struct usb_action mc501cb_NoFlickerScale[] = {
        {0xaa, 0x03, 0x0003}, /* 00,03,03,aa */
        {0xaa, 0x10, 0x00fc}, /* 00,10,fc,aa */
        {0xaa, 0x36, 0x0030}, /* 00,36,30,aa */
        {0xaa, 0x37, 0x00d4}, /* 00,37,D4,aa */
        {0xaa, 0x3d, 0x0030}, /* 00,3D,30,aa */
        {0xaa, 0x3e, 0x00d4}, /* 00,3E,D4,aa */
        {0xaa, 0x3b, 0x0030}, /* 00,3B,30,aa */
        {0xaa, 0x3c, 0x00d4}, /* 00,3C,D4,aa */
        {}
};

/* from zs211.inf */
static const struct usb_action ov7620_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL}, /* 00,00,01,cc */
        {0xa0, 0x40, ZC3XX_R002_CLOCKSELECT}, /* 00,02,40,cc */
        {0xa0, 0x00, ZC3XX_R008_CLOCKSETTING}, /* 00,08,00,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING}, /* 00,01,01,cc */
        {0xa0, 0x06, ZC3XX_R010_CMOSSENSORSELECT}, /* 00,10,06,cc */
        {0xa0, 0x02, ZC3XX_R083_RGAINADDR}, /* 00,83,02,cc */
        {0xa0, 0x01, ZC3XX_R085_BGAINADDR}, /* 00,85,01,cc */
        {0xa0, 0x80, ZC3XX_R086_EXPTIMEHIGH}, /* 00,86,80,cc */
        {0xa0, 0x81, ZC3XX_R087_EXPTIMEMID}, /* 00,87,81,cc */
        {0xa0, 0x10, ZC3XX_R088_EXPTIMELOW}, /* 00,88,10,cc */
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR}, /* 00,8b,a1,cc */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE}, /* 00,8d,08,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH}, /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW}, /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH}, /* 00,05,01,cc */
        {0xa0, 0xd8, ZC3XX_R006_FRAMEHEIGHTLOW}, /* 00,06,d8,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,01,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW}, /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW}, /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW}, /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW}, /* 01,1c,00,cc */
        {0xa0, 0xde, ZC3XX_R09C_WINHEIGHTLOW}, /* 00,9c,de,cc */
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW}, /* 00,9e,86,cc */
        {0xaa, 0x12, 0x0088}, /* 00,12,88,aa */
        {0xaa, 0x12, 0x0048}, /* 00,12,48,aa */
        {0xaa, 0x75, 0x008a}, /* 00,75,8a,aa */
        {0xaa, 0x13, 0x00a3}, /* 00,13,a3,aa */
        {0xaa, 0x04, 0x0000}, /* 00,04,00,aa */
        {0xaa, 0x05, 0x0000}, /* 00,05,00,aa */
        {0xaa, 0x14, 0x0000}, /* 00,14,00,aa */
        {0xaa, 0x15, 0x0004}, /* 00,15,04,aa */
        {0xaa, 0x17, 0x0018}, /* 00,17,18,aa */
        {0xaa, 0x18, 0x00ba}, /* 00,18,ba,aa */
        {0xaa, 0x19, 0x0002}, /* 00,19,02,aa */
        {0xaa, 0x1a, 0x00f1}, /* 00,1a,f1,aa */
        {0xaa, 0x20, 0x0040}, /* 00,20,40,aa */
        {0xaa, 0x24, 0x0088}, /* 00,24,88,aa */
        {0xaa, 0x25, 0x0078}, /* 00,25,78,aa */
        {0xaa, 0x27, 0x00f6}, /* 00,27,f6,aa */
        {0xaa, 0x28, 0x00a0}, /* 00,28,a0,aa */
        {0xaa, 0x21, 0x0000}, /* 00,21,00,aa */
        {0xaa, 0x2a, 0x0083}, /* 00,2a,83,aa */
        {0xaa, 0x2b, 0x0096}, /* 00,2b,96,aa */
        {0xaa, 0x2d, 0x0005}, /* 00,2d,05,aa */
        {0xaa, 0x74, 0x0020}, /* 00,74,20,aa */
        {0xaa, 0x61, 0x0068}, /* 00,61,68,aa */
        {0xaa, 0x64, 0x0088}, /* 00,64,88,aa */
        {0xaa, 0x00, 0x0000}, /* 00,00,00,aa */
        {0xaa, 0x06, 0x0080}, /* 00,06,80,aa */
        {0xaa, 0x01, 0x0090}, /* 00,01,90,aa */
        {0xaa, 0x02, 0x0030}, /* 00,02,30,aa */
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION}, /* 01,01,77,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE}, /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS}, /* 01,89,06,cc */
        {0xa0, 0x00, 0x01ad}, /* 01,ad,00,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE}, /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05}, /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE}, /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS}, /* 03,01,08,cc */
        {0xa0, 0x68, ZC3XX_R116_RGAIN}, /* 01,16,68,cc */
        {0xa0, 0x52, ZC3XX_R118_BGAIN}, /* 01,18,52,cc */
        {0xa0, 0x40, ZC3XX_R11D_GLOBALGAIN}, /* 01,1d,40,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE}, /* 01,80,02,cc */
        {0xa0, 0x50, ZC3XX_R1A8_DIGITALGAIN}, /* 01,a8,50,cc */
        {}
};
static const struct usb_action ov7620_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL}, /* 00,00,01,cc */
        {0xa0, 0x50, ZC3XX_R002_CLOCKSELECT},        /* 00,02,50,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00,08,00,cc */
                                                /* mx change? */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING}, /* 00,01,01,cc */
        {0xa0, 0x06, ZC3XX_R010_CMOSSENSORSELECT}, /* 00,10,06,cc */
        {0xa0, 0x02, ZC3XX_R083_RGAINADDR},        /* 00,83,02,cc */
        {0xa0, 0x01, ZC3XX_R085_BGAINADDR},        /* 00,85,01,cc */
        {0xa0, 0x80, ZC3XX_R086_EXPTIMEHIGH},        /* 00,86,80,cc */
        {0xa0, 0x81, ZC3XX_R087_EXPTIMEMID},        /* 00,87,81,cc */
        {0xa0, 0x10, ZC3XX_R088_EXPTIMELOW},        /* 00,88,10,cc */
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR}, /* 00,8b,a1,cc */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE}, /* 00,8d,08,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH}, /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW}, /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH}, /* 00,05,01,cc */
        {0xa0, 0xd0, ZC3XX_R006_FRAMEHEIGHTLOW}, /* 00,06,d0,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,01,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},        /* 00,98,00,cc */
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},        /* 00,9a,00,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},        /* 01,1a,00,cc */
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},        /* 01,1c,00,cc */
        {0xa0, 0xd6, ZC3XX_R09C_WINHEIGHTLOW},        /* 00,9c,d6,cc */
                                                /* OV7648 00,9c,d8,cc */
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},        /* 00,9e,88,cc */
        {0xaa, 0x12, 0x0088}, /* 00,12,88,aa */
        {0xaa, 0x12, 0x0048}, /* 00,12,48,aa */
        {0xaa, 0x75, 0x008a}, /* 00,75,8a,aa */
        {0xaa, 0x13, 0x00a3}, /* 00,13,a3,aa */
        {0xaa, 0x04, 0x0000}, /* 00,04,00,aa */
        {0xaa, 0x05, 0x0000}, /* 00,05,00,aa */
        {0xaa, 0x14, 0x0000}, /* 00,14,00,aa */
        {0xaa, 0x15, 0x0004}, /* 00,15,04,aa */
        {0xaa, 0x24, 0x0088}, /* 00,24,88,aa */
        {0xaa, 0x25, 0x0078}, /* 00,25,78,aa */
        {0xaa, 0x17, 0x0018}, /* 00,17,18,aa */
        {0xaa, 0x18, 0x00ba}, /* 00,18,ba,aa */
        {0xaa, 0x19, 0x0002}, /* 00,19,02,aa */
        {0xaa, 0x1a, 0x00f2}, /* 00,1a,f2,aa */
        {0xaa, 0x20, 0x0040}, /* 00,20,40,aa */
        {0xaa, 0x27, 0x00f6}, /* 00,27,f6,aa */
        {0xaa, 0x28, 0x00a0}, /* 00,28,a0,aa */
        {0xaa, 0x21, 0x0000}, /* 00,21,00,aa */
        {0xaa, 0x2a, 0x0083}, /* 00,2a,83,aa */
        {0xaa, 0x2b, 0x0096}, /* 00,2b,96,aa */
        {0xaa, 0x2d, 0x0005}, /* 00,2d,05,aa */
        {0xaa, 0x74, 0x0020}, /* 00,74,20,aa */
        {0xaa, 0x61, 0x0068}, /* 00,61,68,aa */
        {0xaa, 0x64, 0x0088}, /* 00,64,88,aa */
        {0xaa, 0x00, 0x0000}, /* 00,00,00,aa */
        {0xaa, 0x06, 0x0080}, /* 00,06,80,aa */
        {0xaa, 0x01, 0x0090}, /* 00,01,90,aa */
        {0xaa, 0x02, 0x0030}, /* 00,02,30,aa */
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION}, /* 01,01,77,cc */
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC}, /* 00,12,05,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE}, /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},        /* 01,89,06,cc */
        {0xa0, 0x00, 0x01ad},                        /* 01,ad,00,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE}, /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},        /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE}, /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},        /* 03,01,08,cc */
        {0xa0, 0x68, ZC3XX_R116_RGAIN},                /* 01,16,68,cc */
        {0xa0, 0x52, ZC3XX_R118_BGAIN},                /* 01,18,52,cc */
        {0xa0, 0x50, ZC3XX_R11D_GLOBALGAIN},        /* 01,1d,50,cc */
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE}, /* 01,80,02,cc */
        {0xa0, 0x50, ZC3XX_R1A8_DIGITALGAIN},        /* 01,a8,50,cc */
        {}
};
static const struct usb_action ov7620_50HZ[] = {
        {0xdd, 0x00, 0x0100},        /* 00,01,00,dd */
        {0xaa, 0x2b, 0x0096},        /* 00,2b,96,aa */
        /* enable 1/120s & 1/100s exposures for banding filter */
        {0xaa, 0x75, 0x008e},
        {0xaa, 0x2d, 0x0005},        /* 00,2d,05,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},        /* 01,91,04,cc */
        {0xa0, 0x18, ZC3XX_R192_EXPOSURELIMITLOW},        /* 01,92,18,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x83, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,83,cc */
        {0xaa, 0x76, 0x0003},                                /* 00,76,03,aa */
/*        {0xa0, 0x40, ZC3XX_R002_CLOCKSELECT},                 * 00,02,40,cc
                                                         * if mode0 (640x480) */
        {}
};
static const struct usb_action ov7620_60HZ[] = {
        {0xdd, 0x00, 0x0100},                        /* 00,01,00,dd */
        {0xaa, 0x2b, 0x0000},                        /* 00,2b,00,aa */
        /* enable 1/120s & 1/100s exposures for banding filter */
        {0xaa, 0x75, 0x008e},
        {0xaa, 0x2d, 0x0005},                        /* 00,2d,05,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x18, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,18,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x83, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,83,cc */
        {0xaa, 0x76, 0x0003},                        /* 00,76,03,aa */
/*        {0xa0, 0x40, ZC3XX_R002_CLOCKSELECT},         * 00,02,40,cc
                                                 * if mode0 (640x480) */
/* ?? in gspca v1, it was
        {0xa0, 0x00, 0x0039},  * 00,00,00,dd *
        {0xa1, 0x01, 0x0037},                */
        {}
};
static const struct usb_action ov7620_NoFlicker[] = {
        {0xdd, 0x00, 0x0100},                        /* 00,01,00,dd */
        {0xaa, 0x2b, 0x0000},                        /* 00,2b,00,aa */
        /* disable 1/120s & 1/100s exposures for banding filter */
        {0xaa, 0x75, 0x008a},
        {0xaa, 0x2d, 0x0001},                        /* 00,2d,01,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,04,cc */
        {0xa0, 0x18, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,18,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x01, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,01,cc */
/*        {0xa0, 0x44, ZC3XX_R002_CLOCKSELECT},         * 00,02,44,cc
                                                 * if mode1 (320x240) */
/* ?? was
        {0xa0, 0x00, 0x0039},  * 00,00,00,dd *
        {0xa1, 0x01, 0x0037},                */
        {}
};

static const struct usb_action ov7630c_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x06, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x12, 0x0080},
        {0xa0, 0x02, ZC3XX_R083_RGAINADDR},
        {0xa0, 0x01, ZC3XX_R085_BGAINADDR},
        {0xa0, 0x90, ZC3XX_R086_EXPTIMEHIGH},
        {0xa0, 0x91, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x10, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xd8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},
        {0xaa, 0x12, 0x0069},
        {0xaa, 0x04, 0x0020},
        {0xaa, 0x06, 0x0050},
        {0xaa, 0x13, 0x0083},
        {0xaa, 0x14, 0x0000},
        {0xaa, 0x15, 0x0024},
        {0xaa, 0x17, 0x0018},
        {0xaa, 0x18, 0x00ba},
        {0xaa, 0x19, 0x0002},
        {0xaa, 0x1a, 0x00f6},
        {0xaa, 0x1b, 0x0002},
        {0xaa, 0x20, 0x00c2},
        {0xaa, 0x24, 0x0060},
        {0xaa, 0x25, 0x0040},
        {0xaa, 0x26, 0x0030},
        {0xaa, 0x27, 0x00ea},
        {0xaa, 0x28, 0x00a0},
        {0xaa, 0x21, 0x0000},
        {0xaa, 0x2a, 0x0081},
        {0xaa, 0x2b, 0x0096},
        {0xaa, 0x2d, 0x0094},
        {0xaa, 0x2f, 0x003d},
        {0xaa, 0x30, 0x0024},
        {0xaa, 0x60, 0x0000},
        {0xaa, 0x61, 0x0040},
        {0xaa, 0x68, 0x007c},
        {0xaa, 0x6f, 0x0015},
        {0xaa, 0x75, 0x0088},
        {0xaa, 0x77, 0x00b5},
        {0xaa, 0x01, 0x0060},
        {0xaa, 0x02, 0x0060},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x46, ZC3XX_R118_BGAIN},
        {0xa0, 0x04, ZC3XX_R113_RGB03},
/* 0x10, */
        {0xa1, 0x01, 0x0002},
        {0xa0, 0x50, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf8, ZC3XX_R10B_RGB01},
        {0xa0, 0xf8, ZC3XX_R10C_RGB02},
        {0xa0, 0xf8, ZC3XX_R10D_RGB10},
        {0xa0, 0x50, ZC3XX_R10E_RGB11},
        {0xa0, 0xf8, ZC3XX_R10F_RGB12},
        {0xa0, 0xf8, ZC3XX_R110_RGB20},
        {0xa0, 0xf8, ZC3XX_R111_RGB21},
        {0xa0, 0x50, ZC3XX_R112_RGB22},
        {0xa1, 0x01, 0x0008},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x01, ZC3XX_R120_GAMMA00},        /* gamma 2 ?*/
        {0xa0, 0x0c, ZC3XX_R121_GAMMA01},
        {0xa0, 0x1f, ZC3XX_R122_GAMMA02},
        {0xa0, 0x3a, ZC3XX_R123_GAMMA03},
        {0xa0, 0x53, ZC3XX_R124_GAMMA04},
        {0xa0, 0x6d, ZC3XX_R125_GAMMA05},
        {0xa0, 0x85, ZC3XX_R126_GAMMA06},
        {0xa0, 0x9c, ZC3XX_R127_GAMMA07},
        {0xa0, 0xb0, ZC3XX_R128_GAMMA08},
        {0xa0, 0xc2, ZC3XX_R129_GAMMA09},
        {0xa0, 0xd1, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xde, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xe9, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xf2, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xf9, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x05, ZC3XX_R130_GAMMA10},
        {0xa0, 0x0f, ZC3XX_R131_GAMMA11},
        {0xa0, 0x16, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1a, ZC3XX_R133_GAMMA13},
        {0xa0, 0x19, ZC3XX_R134_GAMMA14},
        {0xa0, 0x19, ZC3XX_R135_GAMMA15},
        {0xa0, 0x17, ZC3XX_R136_GAMMA16},
        {0xa0, 0x15, ZC3XX_R137_GAMMA17},
        {0xa0, 0x12, ZC3XX_R138_GAMMA18},
        {0xa0, 0x10, ZC3XX_R139_GAMMA19},
        {0xa0, 0x0e, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x0b, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x09, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x08, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x06, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x03, ZC3XX_R13F_GAMMA1F},
        {0xa0, 0x50, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf8, ZC3XX_R10B_RGB01},
        {0xa0, 0xf8, ZC3XX_R10C_RGB02},
        {0xa0, 0xf8, ZC3XX_R10D_RGB10},
        {0xa0, 0x50, ZC3XX_R10E_RGB11},
        {0xa0, 0xf8, ZC3XX_R10F_RGB12},
        {0xa0, 0xf8, ZC3XX_R110_RGB20},
        {0xa0, 0xf8, ZC3XX_R111_RGB21},
        {0xa0, 0x50, ZC3XX_R112_RGB22},

        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xaa, 0x10, 0x001b},
        {0xaa, 0x76, 0x0002},
        {0xaa, 0x2a, 0x0081},
        {0xaa, 0x2b, 0x0000},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x01, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xb8, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x37, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x26, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x50, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xaa, 0x13, 0x0083},        /* 40 */
        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};

static const struct usb_action ov7630c_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x06, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0xa1, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},

        {0xaa, 0x12, 0x0080},
        {0xa0, 0x02, ZC3XX_R083_RGAINADDR},
        {0xa0, 0x01, ZC3XX_R085_BGAINADDR},
        {0xa0, 0x90, ZC3XX_R086_EXPTIMEHIGH},
        {0xa0, 0x91, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x10, ZC3XX_R088_EXPTIMELOW},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xe6, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},
        {0xaa, 0x12, 0x0069},        /* i2c */
        {0xaa, 0x04, 0x0020},
        {0xaa, 0x06, 0x0050},
        {0xaa, 0x13, 0x00c3},
        {0xaa, 0x14, 0x0000},
        {0xaa, 0x15, 0x0024},
        {0xaa, 0x19, 0x0003},
        {0xaa, 0x1a, 0x00f6},
        {0xaa, 0x1b, 0x0002},
        {0xaa, 0x20, 0x00c2},
        {0xaa, 0x24, 0x0060},
        {0xaa, 0x25, 0x0040},
        {0xaa, 0x26, 0x0030},
        {0xaa, 0x27, 0x00ea},
        {0xaa, 0x28, 0x00a0},
        {0xaa, 0x21, 0x0000},
        {0xaa, 0x2a, 0x0081},
        {0xaa, 0x2b, 0x0096},
        {0xaa, 0x2d, 0x0084},
        {0xaa, 0x2f, 0x003d},
        {0xaa, 0x30, 0x0024},
        {0xaa, 0x60, 0x0000},
        {0xaa, 0x61, 0x0040},
        {0xaa, 0x68, 0x007c},
        {0xaa, 0x6f, 0x0015},
        {0xaa, 0x75, 0x0088},
        {0xaa, 0x77, 0x00b5},
        {0xaa, 0x01, 0x0060},
        {0xaa, 0x02, 0x0060},
        {0xaa, 0x17, 0x0018},
        {0xaa, 0x18, 0x00ba},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x77, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x04, ZC3XX_R1A7_CALCGLOBALMEAN},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R116_RGAIN},
        {0xa0, 0x46, ZC3XX_R118_BGAIN},
        {0xa0, 0x04, ZC3XX_R113_RGB03},

        {0xa1, 0x01, 0x0002},
        {0xa0, 0x4e, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xfe, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf7, ZC3XX_R10D_RGB10},
        {0xa0, 0x4d, ZC3XX_R10E_RGB11},
        {0xa0, 0xfc, ZC3XX_R10F_RGB12},
        {0xa0, 0x00, ZC3XX_R110_RGB20},
        {0xa0, 0xf6, ZC3XX_R111_RGB21},
        {0xa0, 0x4a, ZC3XX_R112_RGB22},

        {0xa1, 0x01, 0x0008},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* clock ? */
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},        /* sharpness+ */
        {0xa1, 0x01, 0x01c8},
        {0xa1, 0x01, 0x01c9},
        {0xa1, 0x01, 0x01ca},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},        /* sharpness- */
        {0xa0, 0x16, ZC3XX_R120_GAMMA00},        /* gamma ~4 */
        {0xa0, 0x3a, ZC3XX_R121_GAMMA01},
        {0xa0, 0x5b, ZC3XX_R122_GAMMA02},
        {0xa0, 0x7c, ZC3XX_R123_GAMMA03},
        {0xa0, 0x94, ZC3XX_R124_GAMMA04},
        {0xa0, 0xa9, ZC3XX_R125_GAMMA05},
        {0xa0, 0xbb, ZC3XX_R126_GAMMA06},
        {0xa0, 0xca, ZC3XX_R127_GAMMA07},
        {0xa0, 0xd7, ZC3XX_R128_GAMMA08},
        {0xa0, 0xe1, ZC3XX_R129_GAMMA09},
        {0xa0, 0xea, ZC3XX_R12A_GAMMA0A},
        {0xa0, 0xf1, ZC3XX_R12B_GAMMA0B},
        {0xa0, 0xf7, ZC3XX_R12C_GAMMA0C},
        {0xa0, 0xfc, ZC3XX_R12D_GAMMA0D},
        {0xa0, 0xff, ZC3XX_R12E_GAMMA0E},
        {0xa0, 0xff, ZC3XX_R12F_GAMMA0F},
        {0xa0, 0x20, ZC3XX_R130_GAMMA10},
        {0xa0, 0x22, ZC3XX_R131_GAMMA11},
        {0xa0, 0x20, ZC3XX_R132_GAMMA12},
        {0xa0, 0x1c, ZC3XX_R133_GAMMA13},
        {0xa0, 0x16, ZC3XX_R134_GAMMA14},
        {0xa0, 0x13, ZC3XX_R135_GAMMA15},
        {0xa0, 0x10, ZC3XX_R136_GAMMA16},
        {0xa0, 0x0d, ZC3XX_R137_GAMMA17},
        {0xa0, 0x0b, ZC3XX_R138_GAMMA18},
        {0xa0, 0x09, ZC3XX_R139_GAMMA19},
        {0xa0, 0x07, ZC3XX_R13A_GAMMA1A},
        {0xa0, 0x06, ZC3XX_R13B_GAMMA1B},
        {0xa0, 0x05, ZC3XX_R13C_GAMMA1C},
        {0xa0, 0x04, ZC3XX_R13D_GAMMA1D},
        {0xa0, 0x00, ZC3XX_R13E_GAMMA1E},
        {0xa0, 0x01, ZC3XX_R13F_GAMMA1F},
        {0xa0, 0x4e, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xfe, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf7, ZC3XX_R10D_RGB10},
        {0xa0, 0x4d, ZC3XX_R10E_RGB11},
        {0xa0, 0xfc, ZC3XX_R10F_RGB12},
        {0xa0, 0x00, ZC3XX_R110_RGB20},
        {0xa0, 0xf6, ZC3XX_R111_RGB21},
        {0xa0, 0x4a, ZC3XX_R112_RGB22},

        {0xa1, 0x01, 0x0180},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xaa, 0x10, 0x000d},
        {0xaa, 0x76, 0x0002},
        {0xaa, 0x2a, 0x0081},
        {0xaa, 0x2b, 0x0000},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x00, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xd8, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x1b, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x10, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x26, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x50, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x02, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x40, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xaa, 0x13, 0x00c3},

        {0xa1, 0x01, 0x0180},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};

static const struct usb_action pas106b_Initial_com[] = {
/* Sream and Sensor specific */
        {0xa1, 0x01, 0x0010},        /* CMOSSensorSelect */
/* System */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},        /* SystemControl */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},        /* SystemControl */
/* Picture size */
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},        /* ClockSelect */
        {0xa0, 0x03, 0x003a},
        {0xa0, 0x0c, 0x003b},
        {0xa0, 0x04, 0x0038},
        {}
};

static const struct usb_action pas106b_InitialScale[] = {        /* 176x144 */
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
/* Sream and Sensor specific */
        {0xa0, 0x0f, ZC3XX_R010_CMOSSENSORSELECT},
/* Picture size */
        {0xa0, 0x00, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0xb0, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x00, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0x90, ZC3XX_R006_FRAMEHEIGHTLOW},
/* System */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
/* Sream and Sensor specific */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
/* Sensor Interface */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},
/* Window inside sensor array */
        {0xa0, 0x03, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x03, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x28, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x68, ZC3XX_R09E_WINWIDTHLOW},
/* Init the sensor */
        {0xaa, 0x02, 0x0004},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x09, 0x0005},
        {0xaa, 0x0a, 0x0002},
        {0xaa, 0x0b, 0x0002},
        {0xaa, 0x0c, 0x0005},
        {0xaa, 0x0d, 0x0000},
        {0xaa, 0x0e, 0x0002},
        {0xaa, 0x14, 0x0081},
/* Other registers */
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
/* Frame retrieving */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
/* Gains */
        {0xa0, 0xa0, ZC3XX_R1A8_DIGITALGAIN},
/* Unknown */
        {0xa0, 0x00, 0x01ad},
/* Sharpness */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
/* Other registers */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
/* Auto exposure and white balance */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
/*Dead pixels */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
/* EEPROM */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},
/* Other registers */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
/* Auto exposure and white balance */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
/*Dead pixels */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
/* EEPROM */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},

        {0xa0, 0x58, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf4, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf4, ZC3XX_R10D_RGB10},
        {0xa0, 0x58, ZC3XX_R10E_RGB11},
        {0xa0, 0xf4, ZC3XX_R10F_RGB12},
        {0xa0, 0xf4, ZC3XX_R110_RGB20},
        {0xa0, 0xf4, ZC3XX_R111_RGB21},
        {0xa0, 0x58, ZC3XX_R112_RGB22},
/* Auto correction */
        {0xa0, 0x03, ZC3XX_R181_WINXSTART},
        {0xa0, 0x08, ZC3XX_R182_WINXWIDTH},
        {0xa0, 0x16, ZC3XX_R183_WINXCENTER},
        {0xa0, 0x03, ZC3XX_R184_WINYSTART},
        {0xa0, 0x05, ZC3XX_R185_WINYWIDTH},
        {0xa0, 0x14, ZC3XX_R186_WINYCENTER},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
/* Auto exposure and white balance */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x03, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xb1, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x87, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0c, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x18, ZC3XX_R18F_AEUNFREEZE},
/* sensor on */
        {0xaa, 0x07, 0x00b1},
        {0xaa, 0x05, 0x0003},
        {0xaa, 0x04, 0x0001},
        {0xaa, 0x03, 0x003b},
/* Gains */
        {0xa0, 0x20, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x26, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xa0, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
/* Auto correction */
        {0xa0, 0x40, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},                                /* AutoCorrectEnable */
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
/* Gains */
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},
        {}
};

static const struct usb_action pas106b_Initial[] = {        /* 352x288 */
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
/* Sream and Sensor specific */
        {0xa0, 0x0f, ZC3XX_R010_CMOSSENSORSELECT},
/* Picture size */
        {0xa0, 0x01, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x60, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0x20, ZC3XX_R006_FRAMEHEIGHTLOW},
/* System */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
/* Sream and Sensor specific */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},
/* Sensor Interface */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},
/* Window inside sensor array */
        {0xa0, 0x03, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x03, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0x28, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x68, ZC3XX_R09E_WINWIDTHLOW},
/* Init the sensor */
        {0xaa, 0x02, 0x0004},
        {0xaa, 0x08, 0x0000},
        {0xaa, 0x09, 0x0005},
        {0xaa, 0x0a, 0x0002},
        {0xaa, 0x0b, 0x0002},
        {0xaa, 0x0c, 0x0005},
        {0xaa, 0x0d, 0x0000},
        {0xaa, 0x0e, 0x0002},
        {0xaa, 0x14, 0x0081},
/* Other registers */
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
/* Frame retrieving */
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
/* Gains */
        {0xa0, 0xa0, ZC3XX_R1A8_DIGITALGAIN},
/* Unknown */
        {0xa0, 0x00, 0x01ad},
/* Sharpness */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
/* Other registers */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
/* Auto exposure and white balance */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x80, ZC3XX_R18D_YTARGET},
/*Dead pixels */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
/* EEPROM */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},
/* Other registers */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
/* Auto exposure and white balance */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
/*Dead pixels */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
/* EEPROM */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
/* JPEG control */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x08, ZC3XX_R1C6_SHARPNESS00},
        {0xa0, 0x0f, ZC3XX_R1CB_SHARPNESS05},

        {0xa0, 0x58, ZC3XX_R10A_RGB00},        /* matrix */
        {0xa0, 0xf4, ZC3XX_R10B_RGB01},
        {0xa0, 0xf4, ZC3XX_R10C_RGB02},
        {0xa0, 0xf4, ZC3XX_R10D_RGB10},
        {0xa0, 0x58, ZC3XX_R10E_RGB11},
        {0xa0, 0xf4, ZC3XX_R10F_RGB12},
        {0xa0, 0xf4, ZC3XX_R110_RGB20},
        {0xa0, 0xf4, ZC3XX_R111_RGB21},
        {0xa0, 0x58, ZC3XX_R112_RGB22},
/* Auto correction */
        {0xa0, 0x03, ZC3XX_R181_WINXSTART},
        {0xa0, 0x08, ZC3XX_R182_WINXWIDTH},
        {0xa0, 0x16, ZC3XX_R183_WINXCENTER},
        {0xa0, 0x03, ZC3XX_R184_WINYSTART},
        {0xa0, 0x05, ZC3XX_R185_WINYWIDTH},
        {0xa0, 0x14, ZC3XX_R186_WINYCENTER},
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},

/* Auto exposure and white balance */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x03, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xb1, ZC3XX_R192_EXPOSURELIMITLOW},

        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x87, ZC3XX_R197_ANTIFLICKERLOW},

        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},
/* sensor on */
        {0xaa, 0x07, 0x00b1},
        {0xaa, 0x05, 0x0003},
        {0xaa, 0x04, 0x0001},
        {0xaa, 0x03, 0x003b},
/* Gains */
        {0xa0, 0x20, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x26, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
/* Auto correction */
        {0xa0, 0x40, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa1, 0x01, 0x0180},                                /* AutoCorrectEnable */
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
/* Gains */
        {0xa0, 0x40, ZC3XX_R116_RGAIN},
        {0xa0, 0x40, ZC3XX_R117_GGAIN},
        {0xa0, 0x40, ZC3XX_R118_BGAIN},

        {0xa0, 0x00, 0x0007},                        /* AutoCorrectEnable */
        {0xa0, 0xff, ZC3XX_R018_FRAMELOST},        /* Frame adjust */
        {}
};
static const struct usb_action pas106b_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x06, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,06,cc */
        {0xa0, 0x54, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,54,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x87, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,87,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},        /* 01,8c,10,cc */
        {0xa0, 0x30, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,30,cc */
        {0xaa, 0x03, 0x0021},                        /* 00,03,21,aa */
        {0xaa, 0x04, 0x000c},                        /* 00,04,0c,aa */
        {0xaa, 0x05, 0x0002},                        /* 00,05,02,aa */
        {0xaa, 0x07, 0x001c},                        /* 00,07,1c,aa */
        {0xa0, 0x04, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,04,cc */
        {}
};
static const struct usb_action pas106b_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x06, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,06,cc */
        {0xa0, 0x2e, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,2e,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x71, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,71,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},        /* 01,8c,10,cc */
        {0xa0, 0x30, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,30,cc */
        {0xaa, 0x03, 0x001c},                        /* 00,03,1c,aa */
        {0xaa, 0x04, 0x0004},                        /* 00,04,04,aa */
        {0xaa, 0x05, 0x0001},                        /* 00,05,01,aa */
        {0xaa, 0x07, 0x00c4},                        /* 00,07,c4,aa */
        {0xa0, 0x04, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,04,cc */
        {}
};
static const struct usb_action pas106b_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH}, /* 01,90,00,cc */
        {0xa0, 0x06, ZC3XX_R191_EXPOSURELIMITMID}, /* 01,91,06,cc */
        {0xa0, 0x50, ZC3XX_R192_EXPOSURELIMITLOW}, /* 01,92,50,cc */
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH}, /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID}, /* 01,96,00,cc */
        {0xa0, 0x10, ZC3XX_R197_ANTIFLICKERLOW}, /* 01,97,10,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},        /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},        /* 01,8f,20,cc */
        {0xaa, 0x03, 0x0013},                        /* 00,03,13,aa */
        {0xaa, 0x04, 0x0000},                        /* 00,04,00,aa */
        {0xaa, 0x05, 0x0001},                        /* 00,05,01,aa */
        {0xaa, 0x07, 0x0030},                        /* 00,07,30,aa */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF}, /* 01,a9,00,cc */
        {}
};

/* from lvWIMv.inf 046d:08a2/:08aa 2007/06/03 */
static const struct usb_action pas202b_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},                /* 00,00,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0e, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0e,cc */
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},                /* 00,02,00,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},                /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},        /* 00,06,e0,cc */
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},        /* 00,8d,08,cc */
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},                /* 00,98,00,cc */
        {0xa0, 0x03, ZC3XX_R09A_WINXSTARTLOW},                /* 00,9a,03,cc */
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},                /* 01,1a,00,cc */
        {0xa0, 0x03, ZC3XX_R11C_FIRSTXLOW},                /* 01,1c,03,cc */
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},                /* 00,9b,01,cc */
        {0xa0, 0xe6, ZC3XX_R09C_WINHEIGHTLOW},                /* 00,9c,e6,cc */
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},                /* 00,9d,02,cc */
        {0xa0, 0x86, ZC3XX_R09E_WINWIDTHLOW},                /* 00,9e,86,cc */
        {0xaa, 0x02, 0x0002},                        /* 00,02,04,aa --> 02 */
        {0xaa, 0x07, 0x0006},                                /* 00,07,06,aa */
        {0xaa, 0x08, 0x0002},                                /* 00,08,02,aa */
        {0xaa, 0x09, 0x0006},                                /* 00,09,06,aa */
        {0xaa, 0x0a, 0x0001},                                /* 00,0a,01,aa */
        {0xaa, 0x0b, 0x0001},                                /* 00,0b,01,aa */
        {0xaa, 0x0c, 0x0006},
        {0xaa, 0x0d, 0x0000},                                /* 00,0d,00,aa */
        {0xaa, 0x10, 0x0000},                                /* 00,10,00,aa */
        {0xaa, 0x12, 0x0005},                                /* 00,12,05,aa */
        {0xaa, 0x13, 0x0063},                                /* 00,13,63,aa */
        {0xaa, 0x15, 0x0070},                                /* 00,15,70,aa */
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,b7,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},                /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},                /* 01,89,06,cc */
        {0xa0, 0x00, 0x01ad},                                /* 01,ad,00,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},                /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},                /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},                /* 03,01,08,cc */
        {0xa0, 0x70, ZC3XX_R18D_YTARGET},                /* 01,8d,70,cc */
        {}
};
static const struct usb_action pas202b_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},                /* 00,00,01,cc */
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0e, ZC3XX_R010_CMOSSENSORSELECT},        /* 00,10,0e,cc */
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},                /* 00,02,10,cc */
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},        /* 00,03,02,cc */
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},                /* 00,04,80,cc */
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},        /* 00,05,01,cc */
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},        /* 00,01,01,cc */
        {0xa0, 0x03, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,03,cc */
        {0xa0, 0x01, ZC3XX_R012_VIDEOCONTROLFUNC},        /* 00,12,01,cc */
        {0xa0, 0x08, ZC3XX_R08D_COMPABILITYMODE},        /* 00,8d,08,cc */
        {0xa0, 0x08, ZC3XX_R098_WINYSTARTLOW},                /* 00,98,08,cc */
        {0xa0, 0x02, ZC3XX_R09A_WINXSTARTLOW},                /* 00,9a,02,cc */
        {0xa0, 0x08, ZC3XX_R11A_FIRSTYLOW},                /* 01,1a,08,cc */
        {0xa0, 0x02, ZC3XX_R11C_FIRSTXLOW},                /* 01,1c,02,cc */
        {0xa0, 0x01, ZC3XX_R09B_WINHEIGHTHIGH},                /* 00,9b,01,cc */
        {0xa0, 0xe8, ZC3XX_R09C_WINHEIGHTLOW},
        {0xa0, 0x02, ZC3XX_R09D_WINWIDTHHIGH},                /* 00,9d,02,cc */
        {0xa0, 0x88, ZC3XX_R09E_WINWIDTHLOW},                /* 00,9e,88,cc */
        {0xaa, 0x02, 0x0002},                                /* 00,02,02,aa */
        {0xaa, 0x07, 0x0006},                                /* 00,07,06,aa */
        {0xaa, 0x08, 0x0002},                                /* 00,08,02,aa */
        {0xaa, 0x09, 0x0006},                                /* 00,09,06,aa */
        {0xaa, 0x0a, 0x0001},                                /* 00,0a,01,aa */
        {0xaa, 0x0b, 0x0001},                                /* 00,0b,01,aa */
        {0xaa, 0x0c, 0x0006},
        {0xaa, 0x0d, 0x0000},                                /* 00,0d,00,aa */
        {0xaa, 0x10, 0x0000},                                /* 00,10,00,aa */
        {0xaa, 0x12, 0x0005},                                /* 00,12,05,aa */
        {0xaa, 0x13, 0x0063},                                /* 00,13,63,aa */
        {0xaa, 0x15, 0x0070},                                /* 00,15,70,aa */
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},        /* 01,01,37,cc */
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},                /* 01,00,0d,cc */
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},                /* 01,89,06,cc */
        {0xa0, 0x00, 0x01ad},                                /* 01,ad,00,cc */
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},                /* 01,c5,03,cc */
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},                /* 01,cb,13,cc */
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},        /* 02,50,08,cc */
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},                /* 03,01,08,cc */
        {0xa0, 0x70, ZC3XX_R18D_YTARGET},                /* 01,8d,70,cc */
        {0xa0, 0xff, ZC3XX_R097_WINYSTARTHIGH},
        {0xa0, 0xfe, ZC3XX_R098_WINYSTARTLOW},
        {}
};
static const struct usb_action pas202b_50HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0002},                                /* 00,20,02,aa */
        {0xaa, 0x21, 0x001b},
        {0xaa, 0x03, 0x0044},                                /* 00,03,44,aa */
        {0xaa, 0x04, 0x0008},
        {0xaa, 0x05, 0x001b},
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x1c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x1b, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x4d, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,4d,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1b, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x44, ZC3XX_R01D_HSYNC_0},                /* 00,1d,44,cc */
        {0xa0, 0x6f, ZC3XX_R01E_HSYNC_1},                /* 00,1e,6f,cc */
        {0xa0, 0xad, ZC3XX_R01F_HSYNC_2},                /* 00,1f,ad,cc */
        {0xa0, 0xeb, ZC3XX_R020_HSYNC_3},                /* 00,20,eb,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};
static const struct usb_action pas202b_50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0004},
        {0xaa, 0x21, 0x003d},
        {0xaa, 0x03, 0x0041},                                /* 00,03,41,aa */
        {0xaa, 0x04, 0x0010},
        {0xaa, 0x05, 0x003d},
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x1c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x3d, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x9b, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,9b,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1b, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x41, ZC3XX_R01D_HSYNC_0},                /* 00,1d,41,cc */
        {0xa0, 0x6f, ZC3XX_R01E_HSYNC_1},                /* 00,1e,6f,cc */
        {0xa0, 0xad, ZC3XX_R01F_HSYNC_2},                /* 00,1f,ad,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},                /* 00,20,ff,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};
static const struct usb_action pas202b_60HZ[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0002},                                /* 00,20,02,aa */
        {0xaa, 0x21, 0x0000},                                /* 00,21,00,aa */
        {0xaa, 0x03, 0x0045},                                /* 00,03,45,aa */
        {0xaa, 0x04, 0x0008},                                /* 00,04,08,aa */
        {0xaa, 0x05, 0x0000},                                /* 00,05,00,aa */
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x1c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x00, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x40, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,40,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1b, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x45, ZC3XX_R01D_HSYNC_0},                /* 00,1d,45,cc */
        {0xa0, 0x8e, ZC3XX_R01E_HSYNC_1},                /* 00,1e,8e,cc */
        {0xa0, 0xc1, ZC3XX_R01F_HSYNC_2},                /* 00,1f,c1,cc */
        {0xa0, 0xf5, ZC3XX_R020_HSYNC_3},                /* 00,20,f5,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};
static const struct usb_action pas202b_60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0004},
        {0xaa, 0x21, 0x0008},
        {0xaa, 0x03, 0x0042},                                /* 00,03,42,aa */
        {0xaa, 0x04, 0x0010},
        {0xaa, 0x05, 0x0008},
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x1c, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},        /* 01,aa,24,cc */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x08, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x81, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,81,cc */
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1b, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x42, ZC3XX_R01D_HSYNC_0},                /* 00,1d,42,cc */
        {0xa0, 0x6f, ZC3XX_R01E_HSYNC_1},                /* 00,1e,6f,cc */
        {0xa0, 0xaf, ZC3XX_R01F_HSYNC_2},                /* 00,1f,af,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},                /* 00,20,ff,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};
static const struct usb_action pas202b_NoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0002},                                /* 00,20,02,aa */
        {0xaa, 0x21, 0x0006},
        {0xaa, 0x03, 0x0040},                                /* 00,03,40,aa */
        {0xaa, 0x04, 0x0008},                                /* 00,04,08,aa */
        {0xaa, 0x05, 0x0006},
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x02, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x06, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x01, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},                /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},                /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,00,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x40, ZC3XX_R01D_HSYNC_0},                /* 00,1d,40,cc */
        {0xa0, 0x60, ZC3XX_R01E_HSYNC_1},                /* 00,1e,60,cc */
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},                /* 00,1f,90,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},                /* 00,20,ff,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};
static const struct usb_action pas202b_NoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},                /* 00,19,00,cc */
        {0xa0, 0x20, ZC3XX_R087_EXPTIMEMID},                /* 00,87,20,cc */
        {0xa0, 0x21, ZC3XX_R088_EXPTIMELOW},                /* 00,88,21,cc */
        {0xaa, 0x20, 0x0004},
        {0xaa, 0x21, 0x000c},
        {0xaa, 0x03, 0x0040},                                /* 00,03,40,aa */
        {0xaa, 0x04, 0x0010},
        {0xaa, 0x05, 0x000c},
        {0xaa, 0x0e, 0x0001},                                /* 00,0e,01,aa */
        {0xaa, 0x0f, 0x0000},                                /* 00,0f,00,aa */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},        /* 01,90,00,cc */
        {0xa0, 0x04, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x0c, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},        /* 01,95,00,cc */
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},        /* 01,96,00,cc */
        {0xa0, 0x02, ZC3XX_R197_ANTIFLICKERLOW},        /* 01,97,02,cc */
        {0xa0, 0x10, ZC3XX_R18C_AEFREEZE},                /* 01,8c,10,cc */
        {0xa0, 0x20, ZC3XX_R18F_AEUNFREEZE},                /* 01,8f,20,cc */
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},        /* 01,a9,00,cc */
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x40, ZC3XX_R01D_HSYNC_0},                /* 00,1d,40,cc */
        {0xa0, 0x60, ZC3XX_R01E_HSYNC_1},                /* 00,1e,60,cc */
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},                /* 00,1f,90,cc */
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},                /* 00,20,ff,cc */
        {0xa0, 0x0f, ZC3XX_R087_EXPTIMEMID},                /* 00,87,0f,cc */
        {0xa0, 0x0e, ZC3XX_R088_EXPTIMELOW},                /* 00,88,0e,cc */
        {}
};

/* mt9v111 (mi0360soc) and pb0330 from vm30x.inf 0ac8:301b 07/02/13 */
static const struct usb_action mt9v111_1_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0001},
        {0xaa, 0x06, 0x0000},
        {0xaa, 0x08, 0x0483},
        {0xaa, 0x01, 0x0004},
        {0xaa, 0x08, 0x0006},
        {0xaa, 0x02, 0x0011},
        {0xaa, 0x03, 0x01e5},                        /*jfm: was 01e7*/
        {0xaa, 0x04, 0x0285},                        /*jfm: was 0287*/
        {0xaa, 0x07, 0x3002},
        {0xaa, 0x20, 0x5100},
        {0xaa, 0x35, 0x507f},
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xaa, 0x2b, 0x007f},
        {0xaa, 0x2c, 0x007f},                        /*jfm: was 0030*/
        {0xaa, 0x2d, 0x007f},                        /*jfm: was 0030*/
        {0xaa, 0x2e, 0x007f},                        /*jfm: was 0030*/
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x09, 0x01ad},                        /*jfm: was 00*/
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x6c, ZC3XX_R18D_YTARGET},
        {0xa0, 0x61, ZC3XX_R116_RGAIN},
        {0xa0, 0x65, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action mt9v111_1_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0001},
        {0xaa, 0x06, 0x0000},
        {0xaa, 0x08, 0x0483},
        {0xaa, 0x01, 0x0004},
        {0xaa, 0x08, 0x0006},
        {0xaa, 0x02, 0x0011},
        {0xaa, 0x03, 0x01e7},
        {0xaa, 0x04, 0x0287},
        {0xaa, 0x07, 0x3002},
        {0xaa, 0x20, 0x5100},
        {0xaa, 0x35, 0x007f},                        /*jfm: was 0050*/
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xaa, 0x2b, 0x007f},                        /*jfm: was 28*/
        {0xaa, 0x2c, 0x007f},                        /*jfm: was 30*/
        {0xaa, 0x2d, 0x007f},                        /*jfm: was 30*/
        {0xaa, 0x2e, 0x007f},                        /*jfm: was 28*/
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0xb7, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x09, 0x01ad},                        /*jfm: was 00*/
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x6c, ZC3XX_R18D_YTARGET},
        {0xa0, 0x61, ZC3XX_R116_RGAIN},
        {0xa0, 0x65, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action mt9v111_1_AE50HZ[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xbb, 0x00, 0x0562},
        {0xbb, 0x01, 0x09aa},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x03, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x9b, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x47, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x62, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x90, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xc8, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_1_AE50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xbb, 0x00, 0x0509},
        {0xbb, 0x01, 0x0934},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xd2, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x9a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x66, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_1_AE60HZ[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x003d},
        {0xaa, 0x09, 0x016e},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xdd, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x3d, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x62, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x90, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xc8, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_1_AE60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xbb, 0x00, 0x0509},
        {0xbb, 0x01, 0x0983},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x8f, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x81, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_1_AENoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xbb, 0x00, 0x0509},
        {0xbb, 0x01, 0x0960},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xf0, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x04, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x09, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x40, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xe0, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_1_AENoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xbb, 0x00, 0x0534},
        {0xbb, 0x02, 0x0960},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xf0, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x04, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x34, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x60, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xe0, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
/* from usbvm303.inf 0ac8:303b 07/03/25 (3 - tas5130c) */
static const struct usb_action mt9v111_3_Initial[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0001},                /* select IFP/SOC registers */
        {0xaa, 0x06, 0x0000},                /* operating mode control */
        {0xaa, 0x08, 0x0483},                /* output format control */
                                        /* H red first, V red or blue first,
                                         * raw Bayer, auto flicker */
        {0xaa, 0x01, 0x0004},                /* select sensor core registers */
        {0xaa, 0x08, 0x0006},                /* row start */
        {0xaa, 0x02, 0x0011},                /* column start */
        {0xaa, 0x03, 0x01e5},                /* window height - 1 */
        {0xaa, 0x04, 0x0285},                /* window width - 1 */
        {0xaa, 0x07, 0x3002},                /* output control */
        {0xaa, 0x20, 0x1100},                /* read mode: bits 8 & 12 (?) */
        {0xaa, 0x35, 0x007f},                /* global gain */
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xaa, 0x2b, 0x007f},                /* green1 gain */
        {0xaa, 0x2c, 0x007f},                /* blue gain */
        {0xaa, 0x2d, 0x007f},                /* red gain */
        {0xaa, 0x2e, 0x007f},                /* green2 gain */
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x80, ZC3XX_R18D_YTARGET},
        {0xa0, 0x61, ZC3XX_R116_RGAIN},
        {0xa0, 0x65, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action mt9v111_3_InitialScale[] = {
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xa0, 0xdc, ZC3XX_R08B_I2CDEVICEADDR},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0001},
        {0xaa, 0x06, 0x0000},
        {0xaa, 0x08, 0x0483},
        {0xaa, 0x01, 0x0004},
        {0xaa, 0x08, 0x0006},
        {0xaa, 0x02, 0x0011},
        {0xaa, 0x03, 0x01e7},
        {0xaa, 0x04, 0x0287},
        {0xaa, 0x07, 0x3002},
        {0xaa, 0x20, 0x1100},
        {0xaa, 0x35, 0x007f},
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xaa, 0x2b, 0x007f},
        {0xaa, 0x2c, 0x007f},
        {0xaa, 0x2d, 0x007f},
        {0xaa, 0x2e, 0x007f},
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x00, 0x01ad},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x80, ZC3XX_R18D_YTARGET},
        {0xa0, 0x61, ZC3XX_R116_RGAIN},
        {0xa0, 0x65, ZC3XX_R118_BGAIN},
        {}
};
static const struct usb_action mt9v111_3_AE50HZ[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0009},                /* horizontal blanking */
        {0xaa, 0x09, 0x01ce},                /* shutter width */
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xd2, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x9a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_3_AE50HZScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0009},
        {0xaa, 0x09, 0x01ce},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xd2, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x9a, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_3_AE60HZ[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0009},
        {0xaa, 0x09, 0x0083},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x8f, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x81, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_3_AE60HZScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0009},
        {0xaa, 0x09, 0x0083},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0x8f, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x81, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x14, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x24, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0xd7, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0xf4, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0xf9, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xff, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_3_AENoFlicker[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0034},
        {0xaa, 0x09, 0x0260},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xf0, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x04, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x34, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x60, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xe0, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};
static const struct usb_action mt9v111_3_AENoFlickerScale[] = {
        {0xa0, 0x00, ZC3XX_R180_AUTOCORRECTENABLE},
        {0xa0, 0x00, ZC3XX_R019_AUTOADJUSTFPS},
        {0xaa, 0x05, 0x0034},
        {0xaa, 0x09, 0x0260},
        {0xa0, 0x00, ZC3XX_R190_EXPOSURELIMITHIGH},
        {0xa0, 0x07, ZC3XX_R191_EXPOSURELIMITMID},
        {0xa0, 0xf0, ZC3XX_R192_EXPOSURELIMITLOW},
        {0xa0, 0x00, ZC3XX_R195_ANTIFLICKERHIGH},
        {0xa0, 0x00, ZC3XX_R196_ANTIFLICKERMID},
        {0xa0, 0x04, ZC3XX_R197_ANTIFLICKERLOW},
        {0xa0, 0x0e, ZC3XX_R18C_AEFREEZE},
        {0xa0, 0x1c, ZC3XX_R18F_AEUNFREEZE},
        {0xa0, 0x00, ZC3XX_R1A9_DIGITALLIMITDIFF},
        {0xa0, 0x00, ZC3XX_R1AA_DIGITALGAINSTEP},
        {0xa0, 0x34, ZC3XX_R01D_HSYNC_0},
        {0xa0, 0x60, ZC3XX_R01E_HSYNC_1},
        {0xa0, 0x90, ZC3XX_R01F_HSYNC_2},
        {0xa0, 0xe0, ZC3XX_R020_HSYNC_3},
        {0xa0, 0x60, ZC3XX_R11D_GLOBALGAIN},
        {0xa0, 0x42, ZC3XX_R180_AUTOCORRECTENABLE},
        {}
};

static const struct usb_action pb0330_Initial[] = {        /* 640x480 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x00, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0006},
        {0xaa, 0x02, 0x0011},
        {0xaa, 0x03, 0x01e5},                        /*jfm: was 1e7*/
        {0xaa, 0x04, 0x0285},                        /*jfm: was 0287*/
        {0xaa, 0x06, 0x0003},
        {0xaa, 0x07, 0x3002},
        {0xaa, 0x20, 0x1100},
        {0xaa, 0x2f, 0xf7b0},
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x34, 0x0100},
        {0xaa, 0x35, 0x0060},
        {0xaa, 0x3d, 0x068f},
        {0xaa, 0x40, 0x01e0},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},
        {0xa0, 0x37, ZC3XX_R101_SENSORCORRECTION},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x0d, ZC3XX_R100_OPERATIONMODE},
        {0xa0, 0x06, ZC3XX_R189_AWBSTATUS},
        {0xa0, 0x09, 0x01ad},                        /*jfm: was 00 */
        {0xa0, 0x15, 0x01ae},
        {0xa0, 0x03, ZC3XX_R1C5_SHARPNESSMODE},
        {0xa0, 0x13, ZC3XX_R1CB_SHARPNESS05},
        {0xa0, 0x08, ZC3XX_R250_DEADPIXELSMODE},
        {0xa0, 0x08, ZC3XX_R301_EEPROMACCESS},
        {0xa0, 0x60, ZC3XX_R1A8_DIGITALGAIN},
        {0xa0, 0x78, ZC3XX_R18D_YTARGET},        /*jfm: was 6c*/
        {}
};
static const struct usb_action pb0330_InitialScale[] = {        /* 320x240 */
        {0xa0, 0x01, ZC3XX_R000_SYSTEMCONTROL},
        {0xa0, 0x03, ZC3XX_R008_CLOCKSETTING},        /* 00 */
        {0xa0, 0x0a, ZC3XX_R010_CMOSSENSORSELECT},
        {0xa0, 0x10, ZC3XX_R002_CLOCKSELECT},
        {0xa0, 0x02, ZC3XX_R003_FRAMEWIDTHHIGH},
        {0xa0, 0x80, ZC3XX_R004_FRAMEWIDTHLOW},
        {0xa0, 0x01, ZC3XX_R005_FRAMEHEIGHTHIGH},
        {0xa0, 0xe0, ZC3XX_R006_FRAMEHEIGHTLOW},
        {0xa0, 0x01, ZC3XX_R001_SYSTEMOPERATING},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x07, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xa0, 0x00, ZC3XX_R098_WINYSTARTLOW},
        {0xa0, 0x00, ZC3XX_R09A_WINXSTARTLOW},
        {0xa0, 0x00, ZC3XX_R11A_FIRSTYLOW},
        {0xa0, 0x00, ZC3XX_R11C_FIRSTXLOW},
        {0xdd, 0x00, 0x0200},
        {0xa0, 0x05, ZC3XX_R012_VIDEOCONTROLFUNC},
        {0xaa, 0x01, 0x0006},
        {0xaa, 0x02, 0x0011},
        {0xaa, 0x03, 0x01e7},
        {0xaa, 0x04, 0x0287},
        {0xaa, 0x06, 0x0003},
        {0xaa, 0x07, 0x3002},
        {0xaa, 0x20, 0x1100},
        {0xaa, 0x2f, 0xf7b0},
        {0xaa, 0x30, 0x0005},
        {0xaa, 0x31, 0x0000},
        {0xaa, 0x34, 0x0100},
        {0xaa, 0x35, 0x0060},
        {0xaa, 0x3d, 0x068f},
        {0xaa, 0x40, 0x01e0},
        {0xaa, 0x58, 0x0078},
        {0xaa, 0x62, 0x0411},
        {0xa0, 0x10, ZC3XX_R087_EXPTIMEMID},