aboutsummaryrefslogtreecommitdiffstats
path: root/fs/ecryptfs
diff options
context:
space:
mode:
authorTyler Hicks <tyhicks@linux.vnet.ibm.com>2011-05-24 03:16:51 -0400
committerTyler Hicks <tyhicks@linux.vnet.ibm.com>2011-05-29 13:51:17 -0400
commit5ccf92037c7c6e6f28175fd245284923f939259f (patch)
tree3d9d551131686c9b0f4c6f7ed31ce4db1dbd0327 /fs/ecryptfs
parentc4f790736ca8d7d86883c5aee2ba1caa15cd8da3 (diff)
eCryptfs: Cleanup inode initialization code
The eCryptfs inode get, initialization, and dentry interposition code has two separate paths. One is for when dentry interposition is needed after doing things like a mkdir in the lower filesystem and the other is needed after a lookup. Unlocking new inodes and doing a d_add() needs to happen at different times, depending on which type of dentry interposing is being done. This patch cleans up the inode get and initialization code paths and splits them up so that the locking and d_add() differences mentioned above can be handled appropriately in a later patch. Signed-off-by: Tyler Hicks <tyhicks@linux.vnet.ibm.com> Tested-by: David <david@unsolicited.net>
Diffstat (limited to 'fs/ecryptfs')
-rw-r--r--fs/ecryptfs/ecryptfs_kernel.h3
-rw-r--r--fs/ecryptfs/inode.c134
2 files changed, 69 insertions, 68 deletions
diff --git a/fs/ecryptfs/ecryptfs_kernel.h b/fs/ecryptfs/ecryptfs_kernel.h
index 37224b5fb12..41a45323637 100644
--- a/fs/ecryptfs/ecryptfs_kernel.h
+++ b/fs/ecryptfs/ecryptfs_kernel.h
@@ -628,9 +628,6 @@ struct ecryptfs_open_req {
628struct inode *ecryptfs_get_inode(struct inode *lower_inode, 628struct inode *ecryptfs_get_inode(struct inode *lower_inode,
629 struct super_block *sb); 629 struct super_block *sb);
630void ecryptfs_i_size_init(const char *page_virt, struct inode *inode); 630void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
631int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry,
632 struct dentry *lower_dentry,
633 struct inode *ecryptfs_dir_inode);
634int ecryptfs_decode_and_decrypt_filename(char **decrypted_name, 631int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
635 size_t *decrypted_name_size, 632 size_t *decrypted_name_size,
636 struct dentry *ecryptfs_dentry, 633 struct dentry *ecryptfs_dentry,
diff --git a/fs/ecryptfs/inode.c b/fs/ecryptfs/inode.c
index 704a8c8fe19..fc7d2b74850 100644
--- a/fs/ecryptfs/inode.c
+++ b/fs/ecryptfs/inode.c
@@ -58,85 +58,87 @@ static int ecryptfs_inode_test(struct inode *inode, void *lower_inode)
58 return 0; 58 return 0;
59} 59}
60 60
61static int ecryptfs_inode_set(struct inode *inode, void *lower_inode) 61static int ecryptfs_inode_set(struct inode *inode, void *opaque)
62{ 62{
63 ecryptfs_set_inode_lower(inode, (struct inode *)lower_inode); 63 struct inode *lower_inode = opaque;
64 inode->i_ino = ((struct inode *)lower_inode)->i_ino; 64
65 ecryptfs_set_inode_lower(inode, lower_inode);
66 fsstack_copy_attr_all(inode, lower_inode);
67 /* i_size will be overwritten for encrypted regular files */
68 fsstack_copy_inode_size(inode, lower_inode);
69 inode->i_ino = lower_inode->i_ino;
65 inode->i_version++; 70 inode->i_version++;
66 inode->i_op = &ecryptfs_main_iops;
67 inode->i_fop = &ecryptfs_main_fops;
68 inode->i_mapping->a_ops = &ecryptfs_aops; 71 inode->i_mapping->a_ops = &ecryptfs_aops;
72
73 if (S_ISLNK(inode->i_mode))
74 inode->i_op = &ecryptfs_symlink_iops;
75 else if (S_ISDIR(inode->i_mode))
76 inode->i_op = &ecryptfs_dir_iops;
77 else
78 inode->i_op = &ecryptfs_main_iops;
79
80 if (S_ISDIR(inode->i_mode))
81 inode->i_fop = &ecryptfs_dir_fops;
82 else if (special_file(inode->i_mode))
83 init_special_inode(inode, inode->i_mode, inode->i_rdev);
84 else
85 inode->i_fop = &ecryptfs_main_fops;
86
69 return 0; 87 return 0;
70} 88}
71 89
72struct inode *ecryptfs_get_inode(struct inode *lower_inode, 90static struct inode *__ecryptfs_get_inode(struct inode *lower_inode,
73 struct super_block *sb) 91 struct super_block *sb)
74{ 92{
75 struct inode *inode; 93 struct inode *inode;
76 int rc = 0;
77 94
78 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb)) { 95 if (lower_inode->i_sb != ecryptfs_superblock_to_lower(sb))
79 rc = -EXDEV; 96 return ERR_PTR(-EXDEV);
80 goto out; 97 if (!igrab(lower_inode))
81 } 98 return ERR_PTR(-ESTALE);
82 if (!igrab(lower_inode)) {
83 rc = -ESTALE;
84 goto out;
85 }
86 inode = iget5_locked(sb, (unsigned long)lower_inode, 99 inode = iget5_locked(sb, (unsigned long)lower_inode,
87 ecryptfs_inode_test, ecryptfs_inode_set, 100 ecryptfs_inode_test, ecryptfs_inode_set,
88 lower_inode); 101 lower_inode);
89 if (!inode) { 102 if (!inode) {
90 rc = -EACCES;
91 iput(lower_inode); 103 iput(lower_inode);
92 goto out; 104 return ERR_PTR(-EACCES);
93 } 105 }
94 if (inode->i_state & I_NEW) 106 if (!(inode->i_state & I_NEW))
95 unlock_new_inode(inode);
96 else
97 iput(lower_inode); 107 iput(lower_inode);
98 if (S_ISLNK(lower_inode->i_mode)) 108
99 inode->i_op = &ecryptfs_symlink_iops; 109 return inode;
100 else if (S_ISDIR(lower_inode->i_mode)) 110}
101 inode->i_op = &ecryptfs_dir_iops; 111
102 if (S_ISDIR(lower_inode->i_mode)) 112struct inode *ecryptfs_get_inode(struct inode *lower_inode,
103 inode->i_fop = &ecryptfs_dir_fops; 113 struct super_block *sb)
104 if (special_file(lower_inode->i_mode)) 114{
105 init_special_inode(inode, lower_inode->i_mode, 115 struct inode *inode = __ecryptfs_get_inode(lower_inode, sb);
106 lower_inode->i_rdev); 116
107 fsstack_copy_attr_all(inode, lower_inode); 117 if (!IS_ERR(inode) && (inode->i_state & I_NEW))
108 /* This size will be overwritten for real files w/ headers and 118 unlock_new_inode(inode);
109 * other metadata */ 119
110 fsstack_copy_inode_size(inode, lower_inode);
111 return inode; 120 return inode;
112out:
113 return ERR_PTR(rc);
114} 121}
115 122
116#define ECRYPTFS_INTERPOSE_FLAG_D_ADD 0x00000001
117/** 123/**
118 * ecryptfs_interpose 124 * ecryptfs_interpose
119 * @lower_dentry: Existing dentry in the lower filesystem 125 * @lower_dentry: Existing dentry in the lower filesystem
120 * @dentry: ecryptfs' dentry 126 * @dentry: ecryptfs' dentry
121 * @sb: ecryptfs's super_block 127 * @sb: ecryptfs's super_block
122 * @flags: flags to govern behavior of interpose procedure
123 * 128 *
124 * Interposes upper and lower dentries. 129 * Interposes upper and lower dentries.
125 * 130 *
126 * Returns zero on success; non-zero otherwise 131 * Returns zero on success; non-zero otherwise
127 */ 132 */
128static int ecryptfs_interpose(struct dentry *lower_dentry, 133static int ecryptfs_interpose(struct dentry *lower_dentry,
129 struct dentry *dentry, struct super_block *sb, 134 struct dentry *dentry, struct super_block *sb)
130 u32 flags)
131{ 135{
132 struct inode *lower_inode = lower_dentry->d_inode; 136 struct inode *inode = ecryptfs_get_inode(lower_dentry->d_inode, sb);
133 struct inode *inode = ecryptfs_get_inode(lower_inode, sb); 137
134 if (IS_ERR(inode)) 138 if (IS_ERR(inode))
135 return PTR_ERR(inode); 139 return PTR_ERR(inode);
136 if (flags & ECRYPTFS_INTERPOSE_FLAG_D_ADD) 140 d_instantiate(dentry, inode);
137 d_add(dentry, inode); 141
138 else
139 d_instantiate(dentry, inode);
140 return 0; 142 return 0;
141} 143}
142 144
@@ -218,7 +220,7 @@ ecryptfs_do_create(struct inode *directory_inode,
218 goto out_lock; 220 goto out_lock;
219 } 221 }
220 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry, 222 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry,
221 directory_inode->i_sb, 0); 223 directory_inode->i_sb);
222 if (rc) { 224 if (rc) {
223 ecryptfs_printk(KERN_ERR, "Failure in ecryptfs_interpose\n"); 225 ecryptfs_printk(KERN_ERR, "Failure in ecryptfs_interpose\n");
224 goto out_lock; 226 goto out_lock;
@@ -305,15 +307,15 @@ out:
305} 307}
306 308
307/** 309/**
308 * ecryptfs_lookup_and_interpose_lower - Perform a lookup 310 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
309 */ 311 */
310int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry, 312static int ecryptfs_lookup_interpose(struct dentry *ecryptfs_dentry,
311 struct dentry *lower_dentry, 313 struct dentry *lower_dentry,
312 struct inode *ecryptfs_dir_inode) 314 struct inode *ecryptfs_dir_inode)
313{ 315{
314 struct dentry *lower_dir_dentry; 316 struct dentry *lower_dir_dentry;
315 struct vfsmount *lower_mnt; 317 struct vfsmount *lower_mnt;
316 struct inode *lower_inode; 318 struct inode *inode, *lower_inode;
317 struct ecryptfs_crypt_stat *crypt_stat; 319 struct ecryptfs_crypt_stat *crypt_stat;
318 char *page_virt = NULL; 320 char *page_virt = NULL;
319 int put_lower = 0, rc = 0; 321 int put_lower = 0, rc = 0;
@@ -341,14 +343,16 @@ int ecryptfs_lookup_and_interpose_lower(struct dentry *ecryptfs_dentry,
341 d_add(ecryptfs_dentry, NULL); 343 d_add(ecryptfs_dentry, NULL);
342 goto out; 344 goto out;
343 } 345 }
344 rc = ecryptfs_interpose(lower_dentry, ecryptfs_dentry, 346 inode = __ecryptfs_get_inode(lower_inode, ecryptfs_dir_inode->i_sb);
345 ecryptfs_dir_inode->i_sb, 347 if (IS_ERR(inode)) {
346 ECRYPTFS_INTERPOSE_FLAG_D_ADD); 348 rc = PTR_ERR(inode);
347 if (rc) {
348 printk(KERN_ERR "%s: Error interposing; rc = [%d]\n", 349 printk(KERN_ERR "%s: Error interposing; rc = [%d]\n",
349 __func__, rc); 350 __func__, rc);
350 goto out; 351 goto out;
351 } 352 }
353 if (inode->i_state & I_NEW)
354 unlock_new_inode(inode);
355 d_add(ecryptfs_dentry, inode);
352 if (S_ISDIR(lower_inode->i_mode)) 356 if (S_ISDIR(lower_inode->i_mode))
353 goto out; 357 goto out;
354 if (S_ISLNK(lower_inode->i_mode)) 358 if (S_ISLNK(lower_inode->i_mode))
@@ -442,12 +446,12 @@ static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
442 goto out_d_drop; 446 goto out_d_drop;
443 } 447 }
444 if (lower_dentry->d_inode) 448 if (lower_dentry->d_inode)
445 goto lookup_and_interpose; 449 goto interpose;
446 mount_crypt_stat = &ecryptfs_superblock_to_private( 450 mount_crypt_stat = &ecryptfs_superblock_to_private(
447 ecryptfs_dentry->d_sb)->mount_crypt_stat; 451 ecryptfs_dentry->d_sb)->mount_crypt_stat;
448 if (!(mount_crypt_stat 452 if (!(mount_crypt_stat
449 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES))) 453 && (mount_crypt_stat->flags & ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES)))
450 goto lookup_and_interpose; 454 goto interpose;
451 dput(lower_dentry); 455 dput(lower_dentry);
452 rc = ecryptfs_encrypt_and_encode_filename( 456 rc = ecryptfs_encrypt_and_encode_filename(
453 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size, 457 &encrypted_and_encoded_name, &encrypted_and_encoded_name_size,
@@ -470,9 +474,9 @@ static struct dentry *ecryptfs_lookup(struct inode *ecryptfs_dir_inode,
470 encrypted_and_encoded_name); 474 encrypted_and_encoded_name);
471 goto out_d_drop; 475 goto out_d_drop;
472 } 476 }
473lookup_and_interpose: 477interpose:
474 rc = ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry, lower_dentry, 478 rc = ecryptfs_lookup_interpose(ecryptfs_dentry, lower_dentry,
475 ecryptfs_dir_inode); 479 ecryptfs_dir_inode);
476 goto out; 480 goto out;
477out_d_drop: 481out_d_drop:
478 d_drop(ecryptfs_dentry); 482 d_drop(ecryptfs_dentry);
@@ -500,7 +504,7 @@ static int ecryptfs_link(struct dentry *old_dentry, struct inode *dir,
500 lower_new_dentry); 504 lower_new_dentry);
501 if (rc || !lower_new_dentry->d_inode) 505 if (rc || !lower_new_dentry->d_inode)
502 goto out_lock; 506 goto out_lock;
503 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb, 0); 507 rc = ecryptfs_interpose(lower_new_dentry, new_dentry, dir->i_sb);
504 if (rc) 508 if (rc)
505 goto out_lock; 509 goto out_lock;
506 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode); 510 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
@@ -567,7 +571,7 @@ static int ecryptfs_symlink(struct inode *dir, struct dentry *dentry,
567 kfree(encoded_symname); 571 kfree(encoded_symname);
568 if (rc || !lower_dentry->d_inode) 572 if (rc || !lower_dentry->d_inode)
569 goto out_lock; 573 goto out_lock;
570 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0); 574 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
571 if (rc) 575 if (rc)
572 goto out_lock; 576 goto out_lock;
573 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode); 577 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
@@ -591,7 +595,7 @@ static int ecryptfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
591 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode); 595 rc = vfs_mkdir(lower_dir_dentry->d_inode, lower_dentry, mode);
592 if (rc || !lower_dentry->d_inode) 596 if (rc || !lower_dentry->d_inode)
593 goto out; 597 goto out;
594 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0); 598 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
595 if (rc) 599 if (rc)
596 goto out; 600 goto out;
597 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode); 601 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
@@ -639,7 +643,7 @@ ecryptfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t dev)
639 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev); 643 rc = vfs_mknod(lower_dir_dentry->d_inode, lower_dentry, mode, dev);
640 if (rc || !lower_dentry->d_inode) 644 if (rc || !lower_dentry->d_inode)
641 goto out; 645 goto out;
642 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb, 0); 646 rc = ecryptfs_interpose(lower_dentry, dentry, dir->i_sb);
643 if (rc) 647 if (rc)
644 goto out; 648 goto out;
645 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode); 649 fsstack_copy_attr_times(dir, lower_dir_dentry->d_inode);
t/cgit.cgi/litmus-rt-budgetable-locks.git/.git/commit/include/linux/usb/gadget.h?h=update_litmus_2019&id=41dceed51f0e6105ca2bf45c3835a7cd9eaa077b'>41dceed51f0e
1da177e4c3f4














b0fca50f5a94


c2344f13b59e
1da177e4c3f4


b0fca50f5a94


1da177e4c3f4
b0fca50f5a94

1da177e4c3f4



c2344f13b59e
1da177e4c3f4





329af28b141a

1da177e4c3f4
41dceed51f0e
1da177e4c3f4
2ccea03a8f7e


1da177e4c3f4






























41dceed51f0e
1da177e4c3f4












a4c39c41bf35



a4c39c41bf35








1da177e4c3f4



41dceed51f0e
3ab810f19d71
1da177e4c3f4
a59d6b91cbca




3ab810f19d71
1da177e4c3f4
dda43a0e03a3
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
  
                       














                                                                         



                         
                       
                              
                        
                          
 




                                                                     
                                                          
                                                                   

                                                                  


                                                                 
                               
                                                                     







                                                                         

                                                                           








                                                                      



                                                                           
                                                                         




                                                                      














                                                                              
  
                                                                         
                                                 
   





                                       



                                               
                                             



























                                                                             
                                 

                                                                          
                                                                 
                                 


                                                                    

                                             











                                                                         

                                                        

                                                                          
                                             

                                                                       

                                                                          

                                                                            











                                                                            
                                               
                                       
                                           
                                        
                                                      
                                                           






                                                                             
                                                                       
  
                                                                             













                                                                             
                                                  
 
                                             













                                                                             
                                                   
 
                                    















                                                                             

                                                                         
 
                                                     










                                                                

                                                               
 
                                       


   



                                                                         
                                                           
































                                                                               
                                                                           



                                                                           



                                                                           








                                                                           

                                                                        
 
                                                  















                                                                               
                                                                            
 
                                         






















                                                                              
                                                    
 
                                        














                                                                          
                                                      
 
                                        


   


















                                                                        













                                                                         
                                                       

                                 
                                                












                                                                        
                                                       

                                
                                        




                                                                             

                                                            
                                                                          
                                                            
                                                                            


  
                  
                         












                                                                             
                                                                     





                                                    


                                                          





                                                                       
                               

                                                             

                                                                       
                                                      











                                                                          
                                    

























                                                                          
                                                  
                                                       








                                                            



                                                                         



                                                                      

                                                                          
                                         



                                                             
                                                                        
                                                              



                                                           
                                                                    








                                                                       







                                                               
                                                                    








                                                                       
                                                            
                                                     












                                                                       
   





                                                                        
                                                                    
 
                                              














                                                                         
                                                              


                                   
                                           










                                                                    
                                                                       


                                          
                                                       











                                                                       
                                                                         


                                          
                                                       




                                                                   
                     








                                                                        
                                                                    


                                       
                                                    













                                                                         
                                                                              


                                    
                                                  




                                                                        
                     






                                                                      
                                                                       


                                       
                                                    












                                                                         
                                                               


                                   
                                              
















                                                                           
                                                                  


                                   
                                              


 




                                                                             
                                                
                                                                  



                                                                        

                                                               

                                                                           

                                                             

                                                            

















































                                                                            
                                          






                                                                        
                                      














                                                                             


                                                  
                     


                                                                    


                                                                           
   

                                                             



                                                            
                     





                                                                   

                                                                  
   
                                                                   
 


                                                                                






























                                                                             
                                                                             












                                                                               



                                                    








                                                                             



                                                                             
                                                            
                                                          
 




                                                               
                                                         
 
                                 
/*
 * <linux/usb/gadget.h>
 *
 * We call the USB code inside a Linux-based peripheral device a "gadget"
 * driver, except for the hardware-specific bus glue.  One USB host can
 * master many USB gadgets, but the gadgets are only slaved to one host.
 *
 *
 * (C) Copyright 2002-2004 by David Brownell
 * All Rights Reserved.
 *
 * This software is licensed under the GNU GPL version 2.
 */

#ifndef __LINUX_USB_GADGET_H
#define __LINUX_USB_GADGET_H

#include <linux/device.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/scatterlist.h>
#include <linux/types.h>
#include <linux/usb/ch9.h>

struct usb_ep;

/**
 * struct usb_request - describes one i/o request
 * @buf: Buffer used for data.  Always provide this; some controllers
 *	only use PIO, or don't use DMA for some endpoints.
 * @dma: DMA address corresponding to 'buf'.  If you don't set this
 *	field, and the usb controller needs one, it is responsible
 *	for mapping and unmapping the buffer.
 * @sg: a scatterlist for SG-capable controllers.
 * @num_sgs: number of SG entries
 * @num_mapped_sgs: number of SG entries mapped to DMA (internal)
 * @length: Length of that data
 * @stream_id: The stream id, when USB3.0 bulk streams are being used
 * @no_interrupt: If true, hints that no completion irq is needed.
 *	Helpful sometimes with deep request queues that are handled
 *	directly by DMA controllers.
 * @zero: If true, when writing data, makes the last packet be "short"
 *     by adding a zero length packet as needed;
 * @short_not_ok: When reading data, makes short packets be
 *     treated as errors (queue stops advancing till cleanup).
 * @complete: Function called when request completes, so this request and
 *	its buffer may be re-used.  The function will always be called with
 *	interrupts disabled, and it must not sleep.
 *	Reads terminate with a short packet, or when the buffer fills,
 *	whichever comes first.  When writes terminate, some data bytes
 *	will usually still be in flight (often in a hardware fifo).
 *	Errors (for reads or writes) stop the queue from advancing
 *	until the completion function returns, so that any transfers
 *	invalidated by the error may first be dequeued.
 * @context: For use by the completion callback
 * @list: For use by the gadget driver.
 * @status: Reports completion code, zero or a negative errno.
 *	Normally, faults block the transfer queue from advancing until
 *	the completion callback returns.
 *	Code "-ESHUTDOWN" indicates completion caused by device disconnect,
 *	or when the driver disabled the endpoint.
 * @actual: Reports bytes transferred to/from the buffer.  For reads (OUT
 *	transfers) this may be less than the requested length.  If the
 *	short_not_ok flag is set, short reads are treated as errors
 *	even when status otherwise indicates successful completion.
 *	Note that for writes (IN transfers) some data bytes may still
 *	reside in a device-side FIFO when the request is reported as
 *	complete.
 *
 * These are allocated/freed through the endpoint they're used with.  The
 * hardware's driver can add extra per-request data to the memory it returns,
 * which often avoids separate memory allocations (potential failures),
 * later when the request is queued.
 *
 * Request flags affect request handling, such as whether a zero length
 * packet is written (the "zero" flag), whether a short read should be
 * treated as an error (blocking request queue advance, the "short_not_ok"
 * flag), or hinting that an interrupt is not required (the "no_interrupt"
 * flag, for use with deep request queues).
 *
 * Bulk endpoints can use any size buffers, and can also be used for interrupt
 * transfers. interrupt-only endpoints can be much less functional.
 *
 * NOTE:  this is analogous to 'struct urb' on the host side, except that
 * it's thinner and promotes more pre-allocation.
 */

struct usb_request {
	void			*buf;
	unsigned		length;
	dma_addr_t		dma;

	struct scatterlist	*sg;
	unsigned		num_sgs;
	unsigned		num_mapped_sgs;

	unsigned		stream_id:16;
	unsigned		no_interrupt:1;
	unsigned		zero:1;
	unsigned		short_not_ok:1;

	void			(*complete)(struct usb_ep *ep,
					struct usb_request *req);
	void			*context;
	struct list_head	list;

	int			status;
	unsigned		actual;
};

/*-------------------------------------------------------------------------*/

/* endpoint-specific parts of the api to the usb controller hardware.
 * unlike the urb model, (de)multiplexing layers are not required.
 * (so this api could slash overhead if used on the host side...)
 *
 * note that device side usb controllers commonly differ in how many
 * endpoints they support, as well as their capabilities.
 */
struct usb_ep_ops {
	int (*enable) (struct usb_ep *ep,
		const struct usb_endpoint_descriptor *desc);
	int (*disable) (struct usb_ep *ep);

	struct usb_request *(*alloc_request) (struct usb_ep *ep,
		gfp_t gfp_flags);
	void (*free_request) (struct usb_ep *ep, struct usb_request *req);

	int (*queue) (struct usb_ep *ep, struct usb_request *req,
		gfp_t gfp_flags);
	int (*dequeue) (struct usb_ep *ep, struct usb_request *req);

	int (*set_halt) (struct usb_ep *ep, int value);
	int (*set_wedge) (struct usb_ep *ep);

	int (*fifo_status) (struct usb_ep *ep);
	void (*fifo_flush) (struct usb_ep *ep);
};

/**
 * struct usb_ep - device side representation of USB endpoint
 * @name:identifier for the endpoint, such as "ep-a" or "ep9in-bulk"
 * @ops: Function pointers used to access hardware-specific operations.
 * @ep_list:the gadget's ep_list holds all of its endpoints
 * @maxpacket:The maximum packet size used on this endpoint.  The initial
 *	value can sometimes be reduced (hardware allowing), according to
 *      the endpoint descriptor used to configure the endpoint.
 * @max_streams: The maximum number of streams supported
 *	by this EP (0 - 16, actual number is 2^n)
 * @mult: multiplier, 'mult' value for SS Isoc EPs
 * @maxburst: the maximum number of bursts supported by this EP (for usb3)
 * @driver_data:for use by the gadget driver.
 * @address: used to identify the endpoint when finding descriptor that
 *	matches connection speed
 * @desc: endpoint descriptor.  This pointer is set before the endpoint is
 *	enabled and remains valid until the endpoint is disabled.
 * @comp_desc: In case of SuperSpeed support, this is the endpoint companion
 *	descriptor that is used to configure the endpoint
 *
 * the bus controller driver lists all the general purpose endpoints in
 * gadget->ep_list.  the control endpoint (gadget->ep0) is not in that list,
 * and is accessed only in response to a driver setup() callback.
 */
struct usb_ep {
	void			*driver_data;

	const char		*name;
	const struct usb_ep_ops	*ops;
	struct list_head	ep_list;
	unsigned		maxpacket:16;
	unsigned		max_streams:16;
	unsigned		mult:2;
	unsigned		maxburst:5;
	u8			address;
	const struct usb_endpoint_descriptor	*desc;
	const struct usb_ss_ep_comp_descriptor	*comp_desc;
};

/*-------------------------------------------------------------------------*/

/**
 * usb_ep_enable - configure endpoint, making it usable
 * @ep:the endpoint being configured.  may not be the endpoint named "ep0".
 *	drivers discover endpoints through the ep_list of a usb_gadget.
 *
 * When configurations are set, or when interface settings change, the driver
 * will enable or disable the relevant endpoints.  while it is enabled, an
 * endpoint may be used for i/o until the driver receives a disconnect() from
 * the host or until the endpoint is disabled.
 *
 * the ep0 implementation (which calls this routine) must ensure that the
 * hardware capabilities of each endpoint match the descriptor provided
 * for it.  for example, an endpoint named "ep2in-bulk" would be usable
 * for interrupt transfers as well as bulk, but it likely couldn't be used
 * for iso transfers or for endpoint 14.  some endpoints are fully
 * configurable, with more generic names like "ep-a".  (remember that for
 * USB, "in" means "towards the USB master".)
 *
 * returns zero, or a negative error code.
 */
static inline int usb_ep_enable(struct usb_ep *ep)
{
	return ep->ops->enable(ep, ep->desc);
}

/**
 * usb_ep_disable - endpoint is no longer usable
 * @ep:the endpoint being unconfigured.  may not be the endpoint named "ep0".
 *
 * no other task may be using this endpoint when this is called.
 * any pending and uncompleted requests will complete with status
 * indicating disconnect (-ESHUTDOWN) before this call returns.
 * gadget drivers must call usb_ep_enable() again before queueing
 * requests to the endpoint.
 *
 * returns zero, or a negative error code.
 */
static inline int usb_ep_disable(struct usb_ep *ep)
{
	return ep->ops->disable(ep);
}

/**
 * usb_ep_alloc_request - allocate a request object to use with this endpoint
 * @ep:the endpoint to be used with with the request
 * @gfp_flags:GFP_* flags to use
 *
 * Request objects must be allocated with this call, since they normally
 * need controller-specific setup and may even need endpoint-specific
 * resources such as allocation of DMA descriptors.
 * Requests may be submitted with usb_ep_queue(), and receive a single
 * completion callback.  Free requests with usb_ep_free_request(), when
 * they are no longer needed.
 *
 * Returns the request, or null if one could not be allocated.
 */
static inline struct usb_request *usb_ep_alloc_request(struct usb_ep *ep,
						       gfp_t gfp_flags)
{
	return ep->ops->alloc_request(ep, gfp_flags);
}

/**
 * usb_ep_free_request - frees a request object
 * @ep:the endpoint associated with the request
 * @req:the request being freed
 *
 * Reverses the effect of usb_ep_alloc_request().
 * Caller guarantees the request is not queued, and that it will
 * no longer be requeued (or otherwise used).
 */
static inline void usb_ep_free_request(struct usb_ep *ep,
				       struct usb_request *req)
{
	ep->ops->free_request(ep, req);
}

/**
 * usb_ep_queue - queues (submits) an I/O request to an endpoint.
 * @ep:the endpoint associated with the request
 * @req:the request being submitted
 * @gfp_flags: GFP_* flags to use in case the lower level driver couldn't
 *	pre-allocate all necessary memory with the request.
 *
 * This tells the device controller to perform the specified request through
 * that endpoint (reading or writing a buffer).  When the request completes,
 * including being canceled by usb_ep_dequeue(), the request's completion
 * routine is called to return the request to the driver.  Any endpoint
 * (except control endpoints like ep0) may have more than one transfer
 * request queued; they complete in FIFO order.  Once a gadget driver
 * submits a request, that request may not be examined or modified until it
 * is given back to that driver through the completion callback.
 *
 * Each request is turned into one or more packets.  The controller driver
 * never merges adjacent requests into the same packet.  OUT transfers
 * will sometimes use data that's already buffered in the hardware.
 * Drivers can rely on the fact that the first byte of the request's buffer
 * always corresponds to the first byte of some USB packet, for both
 * IN and OUT transfers.
 *
 * Bulk endpoints can queue any amount of data; the transfer is packetized
 * automatically.  The last packet will be short if the request doesn't fill it
 * out completely.  Zero length packets (ZLPs) should be avoided in portable
 * protocols since not all usb hardware can successfully handle zero length
 * packets.  (ZLPs may be explicitly written, and may be implicitly written if
 * the request 'zero' flag is set.)  Bulk endpoints may also be used
 * for interrupt transfers; but the reverse is not true, and some endpoints
 * won't support every interrupt transfer.  (Such as 768 byte packets.)
 *
 * Interrupt-only endpoints are less functional than bulk endpoints, for
 * example by not supporting queueing or not handling buffers that are
 * larger than the endpoint's maxpacket size.  They may also treat data
 * toggle differently.
 *
 * Control endpoints ... after getting a setup() callback, the driver queues
 * one response (even if it would be zero length).  That enables the
 * status ack, after transferring data as specified in the response.  Setup
 * functions may return negative error codes to generate protocol stalls.
 * (Note that some USB device controllers disallow protocol stall responses
 * in some cases.)  When control responses are deferred (the response is
 * written after the setup callback returns), then usb_ep_set_halt() may be
 * used on ep0 to trigger protocol stalls.  Depending on the controller,
 * it may not be possible to trigger a status-stage protocol stall when the
 * data stage is over, that is, from within the response's completion
 * routine.
 *
 * For periodic endpoints, like interrupt or isochronous ones, the usb host
 * arranges to poll once per interval, and the gadget driver usually will
 * have queued some data to transfer at that time.
 *
 * Returns zero, or a negative error code.  Endpoints that are not enabled
 * report errors; errors will also be
 * reported when the usb peripheral is disconnected.
 */
static inline int usb_ep_queue(struct usb_ep *ep,
			       struct usb_request *req, gfp_t gfp_flags)
{
	return ep->ops->queue(ep, req, gfp_flags);
}

/**
 * usb_ep_dequeue - dequeues (cancels, unlinks) an I/O request from an endpoint
 * @ep:the endpoint associated with the request
 * @req:the request being canceled
 *
 * if the request is still active on the endpoint, it is dequeued and its
 * completion routine is called (with status -ECONNRESET); else a negative
 * error code is returned.
 *
 * note that some hardware can't clear out write fifos (to unlink the request
 * at the head of the queue) except as part of disconnecting from usb.  such
 * restrictions prevent drivers from supporting configuration changes,
 * even to configuration zero (a "chapter 9" requirement).
 */
static inline int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req)
{
	return ep->ops->dequeue(ep, req);
}

/**
 * usb_ep_set_halt - sets the endpoint halt feature.
 * @ep: the non-isochronous endpoint being stalled
 *
 * Use this to stall an endpoint, perhaps as an error report.
 * Except for control endpoints,
 * the endpoint stays halted (will not stream any data) until the host
 * clears this feature; drivers may need to empty the endpoint's request
 * queue first, to make sure no inappropriate transfers happen.
 *
 * Note that while an endpoint CLEAR_FEATURE will be invisible to the
 * gadget driver, a SET_INTERFACE will not be.  To reset endpoints for the
 * current altsetting, see usb_ep_clear_halt().  When switching altsettings,
 * it's simplest to use usb_ep_enable() or usb_ep_disable() for the endpoints.
 *
 * Returns zero, or a negative error code.  On success, this call sets
 * underlying hardware state that blocks data transfers.
 * Attempts to halt IN endpoints will fail (returning -EAGAIN) if any
 * transfer requests are still queued, or if the controller hardware
 * (usually a FIFO) still holds bytes that the host hasn't collected.
 */
static inline int usb_ep_set_halt(struct usb_ep *ep)
{
	return ep->ops->set_halt(ep, 1);
}

/**
 * usb_ep_clear_halt - clears endpoint halt, and resets toggle
 * @ep:the bulk or interrupt endpoint being reset
 *
 * Use this when responding to the standard usb "set interface" request,
 * for endpoints that aren't reconfigured, after clearing any other state
 * in the endpoint's i/o queue.
 *
 * Returns zero, or a negative error code.  On success, this call clears
 * the underlying hardware state reflecting endpoint halt and data toggle.
 * Note that some hardware can't support this request (like pxa2xx_udc),
 * and accordingly can't correctly implement interface altsettings.
 */
static inline int usb_ep_clear_halt(struct usb_ep *ep)
{
	return ep->ops->set_halt(ep, 0);
}

/**
 * usb_ep_set_wedge - sets the halt feature and ignores clear requests
 * @ep: the endpoint being wedged
 *
 * Use this to stall an endpoint and ignore CLEAR_FEATURE(HALT_ENDPOINT)
 * requests. If the gadget driver clears the halt status, it will
 * automatically unwedge the endpoint.
 *
 * Returns zero on success, else negative errno.
 */
static inline int
usb_ep_set_wedge(struct usb_ep *ep)
{
	if (ep->ops->set_wedge)
		return ep->ops->set_wedge(ep);
	else
		return ep->ops->set_halt(ep, 1);
}

/**
 * usb_ep_fifo_status - returns number of bytes in fifo, or error
 * @ep: the endpoint whose fifo status is being checked.
 *
 * FIFO endpoints may have "unclaimed data" in them in certain cases,
 * such as after aborted transfers.  Hosts may not have collected all
 * the IN data written by the gadget driver (and reported by a request
 * completion).  The gadget driver may not have collected all the data
 * written OUT to it by the host.  Drivers that need precise handling for
 * fault reporting or recovery may need to use this call.
 *
 * This returns the number of such bytes in the fifo, or a negative
 * errno if the endpoint doesn't use a FIFO or doesn't support such
 * precise handling.
 */
static inline int usb_ep_fifo_status(struct usb_ep *ep)
{
	if (ep->ops->fifo_status)
		return ep->ops->fifo_status(ep);
	else
		return -EOPNOTSUPP;
}

/**
 * usb_ep_fifo_flush - flushes contents of a fifo
 * @ep: the endpoint whose fifo is being flushed.
 *
 * This call may be used to flush the "unclaimed data" that may exist in
 * an endpoint fifo after abnormal transaction terminations.  The call
 * must never be used except when endpoint is not being used for any
 * protocol translation.
 */
static inline void usb_ep_fifo_flush(struct usb_ep *ep)
{
	if (ep->ops->fifo_flush)
		ep->ops->fifo_flush(ep);
}


/*-------------------------------------------------------------------------*/

struct usb_dcd_config_params {
	__u8  bU1devExitLat;	/* U1 Device exit Latency */
#define USB_DEFAULT_U1_DEV_EXIT_LAT	0x01	/* Less then 1 microsec */
	__le16 bU2DevExitLat;	/* U2 Device exit Latency */
#define USB_DEFAULT_U2_DEV_EXIT_LAT	0x1F4	/* Less then 500 microsec */
};


struct usb_gadget;
struct usb_gadget_driver;

/* the rest of the api to the controller hardware: device operations,
 * which don't involve endpoints (or i/o).
 */
struct usb_gadget_ops {
	int	(*get_frame)(struct usb_gadget *);
	int	(*wakeup)(struct usb_gadget *);
	int	(*set_selfpowered) (struct usb_gadget *, int is_selfpowered);
	int	(*vbus_session) (struct usb_gadget *, int is_active);
	int	(*vbus_draw) (struct usb_gadget *, unsigned mA);
	int	(*pullup) (struct usb_gadget *, int is_on);
	int	(*ioctl)(struct usb_gadget *,
				unsigned code, unsigned long param);
	void	(*get_config_params)(struct usb_dcd_config_params *);
	int	(*udc_start)(struct usb_gadget *,
			struct usb_gadget_driver *);
	int	(*udc_stop)(struct usb_gadget *,
			struct usb_gadget_driver *);

	/* Those two are deprecated */
	int	(*start)(struct usb_gadget_driver *,
			int (*bind)(struct usb_gadget *));
	int	(*stop)(struct usb_gadget_driver *);
};

/**
 * struct usb_gadget - represents a usb slave device
 * @ops: Function pointers used to access hardware-specific operations.
 * @ep0: Endpoint zero, used when reading or writing responses to
 *	driver setup() requests
 * @ep_list: List of other endpoints supported by the device.
 * @speed: Speed of current connection to USB host.
 * @max_speed: Maximal speed the UDC can handle.  UDC must support this
 *      and all slower speeds.
 * @sg_supported: true if we can handle scatter-gather
 * @is_otg: True if the USB device port uses a Mini-AB jack, so that the
 *	gadget driver must provide a USB OTG descriptor.
 * @is_a_peripheral: False unless is_otg, the "A" end of a USB cable
 *	is in the Mini-AB jack, and HNP has been used to switch roles
 *	so that the "A" device currently acts as A-Peripheral, not A-Host.
 * @a_hnp_support: OTG device feature flag, indicating that the A-Host
 *	supports HNP at this port.
 * @a_alt_hnp_support: OTG device feature flag, indicating that the A-Host
 *	only supports HNP on a different root port.
 * @b_hnp_enable: OTG device feature flag, indicating that the A-Host
 *	enabled HNP support.
 * @name: Identifies the controller hardware type.  Used in diagnostics
 *	and sometimes configuration.
 * @dev: Driver model state for this abstract device.
 *
 * Gadgets have a mostly-portable "gadget driver" implementing device
 * functions, handling all usb configurations and interfaces.  Gadget
 * drivers talk to hardware-specific code indirectly, through ops vectors.
 * That insulates the gadget driver from hardware details, and packages
 * the hardware endpoints through generic i/o queues.  The "usb_gadget"
 * and "usb_ep" interfaces provide that insulation from the hardware.
 *
 * Except for the driver data, all fields in this structure are
 * read-only to the gadget driver.  That driver data is part of the
 * "driver model" infrastructure in 2.6 (and later) kernels, and for
 * earlier systems is grouped in a similar structure that's not known
 * to the rest of the kernel.
 *
 * Values of the three OTG device feature flags are updated before the
 * setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before
 * driver suspend() calls.  They are valid only when is_otg, and when the
 * device is acting as a B-Peripheral (so is_a_peripheral is false).
 */
struct usb_gadget {
	/* readonly to gadget driver */
	const struct usb_gadget_ops	*ops;
	struct usb_ep			*ep0;
	struct list_head		ep_list;	/* of usb_ep */
	enum usb_device_speed		speed;
	enum usb_device_speed		max_speed;
	unsigned			sg_supported:1;
	unsigned			is_otg:1;
	unsigned			is_a_peripheral:1;
	unsigned			b_hnp_enable:1;
	unsigned			a_hnp_support:1;
	unsigned			a_alt_hnp_support:1;
	const char			*name;
	struct device			dev;
};

static inline void set_gadget_data(struct usb_gadget *gadget, void *data)
	{ dev_set_drvdata(&gadget->dev, data); }
static inline void *get_gadget_data(struct usb_gadget *gadget)
	{ return dev_get_drvdata(&gadget->dev); }
static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev)
{
	return container_of(dev, struct usb_gadget, dev);
}

/* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */
#define gadget_for_each_ep(tmp, gadget) \
	list_for_each_entry(tmp, &(gadget)->ep_list, ep_list)


/**
 * gadget_is_dualspeed - return true iff the hardware handles high speed
 * @g: controller that might support both high and full speeds
 */
static inline int gadget_is_dualspeed(struct usb_gadget *g)
{