Commit 1ec779b9 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: packing: move it to core-api book and adjust markups 



The packing.txt file was misplaced, as docs should be part of
a documentation book, and not at the root dir.

So, move it to the core-api directory and add to its index.

Also, ensure that the file will be properly parsed and the bitmap
ascii artwork will use a monotonic font.

Fixes: 554aae35 ("lib: Add support for generic packing operations")
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Reviewed-by: default avatarVladimir Oltean <olteanv@gmail.com>
Tested-by: default avatarVladimir Oltean <olteanv@gmail.com>
Reviewed-by: default avatarMike Rapoport <rppt@linux.ibm.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f6ae22d6

Documentation/core-api/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ Core utilities 
   librs

   genalloc

   errseq

   packing

   printk-formats

   circular-buffers

   generic-radix-tree

Documentation/packing.txt→Documentation/core-api/packing.rst

+49 −32
Original line number Diff line number Diff line
@@ -30,6 +30,7 @@ The solution 
------------



This API deals with 2 basic operations:



  - Packing a CPU-usable number into a memory buffer (with hardware

    constraints/quirks)

  - Unpacking a memory buffer (which has hardware constraints/quirks)
@@ -49,6 +50,8 @@ What the examples show is where the logical bytes and bits sit. 


1. Normally (no quirks), we would do it like this:



::



  63 62 61 60 59 58 57 56 55 54 53 52 51 50 49 48 47 46 45 44 43 42 41 40 39 38 37 36 35 34 33 32

  7                       6                       5                        4

  31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
@@ -63,6 +66,8 @@ comments as "logical" notation. 


2. If QUIRK_MSB_ON_THE_RIGHT is set, we do it like this:



::



  56 57 58 59 60 61 62 63 48 49 50 51 52 53 54 55 40 41 42 43 44 45 46 47 32 33 34 35 36 37 38 39

  7                       6                        5                       4

  24 25 26 27 28 29 30 31 16 17 18 19 20 21 22 23  8  9 10 11 12 13 14 15  0  1  2  3  4  5  6  7
@@ -74,6 +79,8 @@ inverts bit offsets inside a byte. 


3. If QUIRK_LITTLE_ENDIAN is set, we do it like this:



::



  39 38 37 36 35 34 33 32 47 46 45 44 43 42 41 40 55 54 53 52 51 50 49 48 63 62 61 60 59 58 57 56

  4                       5                       6                       7

  7  6  5  4  3  2  1  0  15 14 13 12 11 10  9  8 23 22 21 20 19 18 17 16 31 30 29 28 27 26 25 24
@@ -86,6 +93,8 @@ the boundary of that word. 
4. If QUIRK_MSB_ON_THE_RIGHT and QUIRK_LITTLE_ENDIAN are both set, we do it

   like this:



::



  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

  4                       5                       6                       7

  0  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
@@ -94,6 +103,8 @@ the boundary of that word. 


5. If just QUIRK_LSW32_IS_FIRST is set, we do it like this:



::



  31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0

  3                       2                       1                        0

  63 62 61 60 59 58 57 56 55 54 53 52 51 50 49 48 47 46 45 44 43 42 41 40 39 38 37 36 35 34 33 32
@@ -107,6 +118,8 @@ the more significant 4-byte word. 
6. If QUIRK_LSW32_IS_FIRST and QUIRK_MSB_ON_THE_RIGHT are set, we do it like

   this:



::



  24 25 26 27 28 29 30 31 16 17 18 19 20 21 22 23  8  9 10 11 12 13 14 15  0  1  2  3  4  5  6  7

  3                       2                        1                       0

  56 57 58 59 60 61 62 63 48 49 50 51 52 53 54 55 40 41 42 43 44 45 46 47 32 33 34 35 36 37 38 39
@@ -116,6 +129,8 @@ the more significant 4-byte word. 
7. If QUIRK_LSW32_IS_FIRST and QUIRK_LITTLE_ENDIAN are set, it looks like

   this:



::



  7  6  5  4  3  2  1  0  15 14 13 12 11 10  9  8 23 22 21 20 19 18 17 16 31 30 29 28 27 26 25 24

  0                       1                       2                       3

  39 38 37 36 35 34 33 32 47 46 45 44 43 42 41 40 55 54 53 52 51 50 49 48 63 62 61 60 59 58 57 56
@@ -125,6 +140,8 @@ the more significant 4-byte word. 
8. If QUIRK_LSW32_IS_FIRST, QUIRK_LITTLE_ENDIAN and QUIRK_MSB_ON_THE_RIGHT

   are set, it looks like this:



::



  0  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

  0                       1                       2                       3

  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

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -12099,7 +12099,7 @@ L: netdev@vger.kernel.org 
S:	Supported

F:	lib/packing.c

F:	include/linux/packing.h

F:	Documentation/packing.txt

F:	Documentation/core-api/packing.rst



PADATA PARALLEL EXECUTION MECHANISM

M:	Steffen Klassert <steffen.klassert@secunet.com>

CRA Git | Maintained and supported by SUSTech CRA and CCSE