Merge branch 'for-5.11' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq
[linux-2.6-microblaze.git] / Documentation / filesystems / bfs.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 ========================
4 BFS Filesystem for Linux
5 ========================
6
7 The BFS filesystem is used by SCO UnixWare OS for the /stand slice, which
8 usually contains the kernel image and a few other files required for the
9 boot process.
10
11 In order to access /stand partition under Linux you obviously need to
12 know the partition number and the kernel must support UnixWare disk slices
13 (CONFIG_UNIXWARE_DISKLABEL config option). However BFS support does not
14 depend on having UnixWare disklabel support because one can also mount
15 BFS filesystem via loopback::
16
17     # losetup /dev/loop0 stand.img
18     # mount -t bfs /dev/loop0 /mnt/stand
19
20 where stand.img is a file containing the image of BFS filesystem.
21 When you have finished using it and umounted you need to also deallocate
22 /dev/loop0 device by::
23
24     # losetup -d /dev/loop0
25
26 You can simplify mounting by just typing::
27
28     # mount -t bfs -o loop stand.img /mnt/stand
29
30 this will allocate the first available loopback device (and load loop.o
31 kernel module if necessary) automatically. If the loopback driver is not
32 loaded automatically, make sure that you have compiled the module and
33 that modprobe is functioning. Beware that umount will not deallocate
34 /dev/loopN device if /etc/mtab file on your system is a symbolic link to
35 /proc/mounts. You will need to do it manually using "-d" switch of
36 losetup(8). Read losetup(8) manpage for more info.
37
38 To create the BFS image under UnixWare you need to find out first which
39 slice contains it. The command prtvtoc(1M) is your friend::
40
41     # prtvtoc /dev/rdsk/c0b0t0d0s0
42
43 (assuming your root disk is on target=0, lun=0, bus=0, controller=0). Then you
44 look for the slice with tag "STAND", which is usually slice 10. With this
45 information you can use dd(1) to create the BFS image::
46
47     # umount /stand
48     # dd if=/dev/rdsk/c0b0t0d0sa of=stand.img bs=512
49
50 Just in case, you can verify that you have done the right thing by checking
51 the magic number::
52
53     # od -Ad -tx4 stand.img | more
54
55 The first 4 bytes should be 0x1badface.
56
57 If you have any patches, questions or suggestions regarding this BFS
58 implementation please contact the author:
59
60 Tigran Aivazian <aivazian.tigran@gmail.com>