{"id":1888,"date":"2016-04-30T00:01:46","date_gmt":"2016-04-30T07:01:46","guid":{"rendered":"http:\/\/c-for-dummies.com\/blog\/?p=1888"},"modified":"2016-05-07T12:33:23","modified_gmt":"2016-05-07T19:33:23","slug":"reading-a-wide-bit-field","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=1888","title":{"rendered":"Reading a Wide Bit Field"},"content":{"rendered":"

The same programming kung fu used to read a single bit also applies to wide bit fields. The process involves masking and shifting: You must know the bit field’s width and position in an integer value. Once those values are obtained — no matter how wide the bit field — a single function handles the job.
\n
\nThe function I crafted to read a wide bit field is called bit_field_read()<\/em>. Here is its prototype:<\/p>\n

unsigned char bit_field_read(char bit, char width, char byte);<\/code><\/p>\n

The argument bit<\/code> is the position in the integer value, here limited to unsigned char<\/em> variables. Position 0 is the far right bit and the values range up to 7 for the far left bit.<\/p>\n

width<\/code> is the size of the chunk to read, which can range from 1 to read a single bit or 8 to read the entire byte.<\/p>\n

Finally, byte<\/code> is the value containing the bit field.<\/p>\n

My function doesn’t do any error checking, so it’s possible to read a bit not within the byte or a chunk wider than the byte. If I were coding bit_field_read()<\/em> for use “in the wild” I would definitely add such bounds checking.<\/p>\n

What the bit_field_read()<\/em> function does is to shift bits in the byte right so that the field starts at bit 0. Then the field width is masked. The result is the value desired. Figure 1 demonstrates how a bit field 4-bits wide at position 2 would be processed by the bit_field_read()<\/em> function.<\/p>\n

\"Figure

Figure 1. Processing a field 4-bits wide.<\/p><\/div>\n

The tough part of the function is to convert the width<\/code> value into a proper bit mask. For example, the value 2 specifies a width of two bits, but in binary the value 2 is 10<\/code> and the mask should be 11<\/code>, which is decimal 3. Table 1 shows how the width values need to be converted.<\/p>\n\n\n\n\n\n\n\n\n\n\n
Field width<\/th>\nBinary mask<\/th>\nDecimal value (unsigned)<\/th>\n<\/tr>\n
1<\/td>\n0000-0001<\/td>\n1<\/td>\n<\/tr>\n
2<\/td>\n0000-0011<\/td>\n3<\/td>\n<\/tr>\n
3<\/td>\n0000-0111<\/td>\n7<\/td>\n<\/tr>\n
4<\/td>\n0000-1111<\/td>\n15<\/td>\n<\/tr>\n
5<\/td>\n0001-1111<\/td>\n31<\/td>\n<\/tr>\n
6<\/td>\n0011-1111<\/td>\n63<\/td>\n<\/tr>\n
7<\/td>\n0111-1111<\/td>\n127<\/td>\n<\/tr>\n
8<\/td>\n1111-1111<\/td>\n255<\/td>\n<\/tr>\n<\/table>\n

To solve the puzzle, you must get from a value like 3 to the value 7. The solution I devised uses binary manipulation to add a bit to a byte, shift the value left, then keep looping to add bits. Here is that code snippet:<\/p>\n

\r\n    mask = 0;\r\n    while(width--)\r\n    {\r\n        mask = mask << 1;\r\n        mask |= 1;\r\n    }<\/pre>\n
The variable width<\/code> holds the original width value, such as 3. mask<\/code> holds the final value, such as 7. The mask starts as 0. Its bits are shifted right, which has no effect when the loop begins. Then the mask |= 1<\/code> statement sets bit 0. If the value of width<\/code> is larger, the loop continues. Bit 0 is shifted to bit 1, then bit 0 is set again. Figure 2 illustrates this process.<\/p>\n
\"Figure
Figure 2. How decimal widths are converted into binary masks.<\/p><\/div>\n
In the end, the width<\/code> value is converted the proper mask<\/code> value, just as shown in Table 1. The mask<\/code> value is used in the bit_field_read()<\/em> function to properly mask bits in the given integer value.<\/p>\n
Here is a demo program that does the same conversions as shown in last week’s Lesson<\/a>, though the bit_field_read()<\/em> function is used instead:<\/p>\n
\r\n#include <stdio.h>\r\n\r\nchar bit_field_read(char bit, char width, char byte);\r\n\r\nint main()\r\n{\r\n    unsigned char board;\r\n\r\n    board = 23;\r\n\r\n    printf(\"The Queen is at row %d, column %d\\n\",\r\n            bit_field_read(3,3,board)+1,\r\n            bit_field_read(0,3,board)+1\r\n            );\r\n\r\n    return(0);\r\n}\r\n\r\nchar bit_field_read(char bit, char width, char byte)\r\n{\r\n    unsigned char mask;\r\n\r\n    mask = 0;\r\n    while(width--)\r\n    {\r\n        mask = mask << 1;\r\n        mask |= 1;\r\n    }\r\n\r\n    byte = byte >> bit;\r\n    return( byte & mask );\r\n}<\/pre>\n
The output from the code is the same as last week:<\/p>\n
The Queen is at row 3, column 8<\/code><\/pre>\n
The bit_field_read()<\/em> function works on any size field from 1 bit wide to the entire byte. So the function can also be used to read on-off values similar to the bit_test()<\/em> function from an earlier Lesson<\/a>.<\/p>\n
A bit_field_write()<\/em> function involves a bit more manipulation to put a bit field into an integer value. I’ll demonstrate that function in next week’s Lesson<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
You don’t need much trickery to read only part of a byte. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-1888","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1888","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1888"}],"version-history":[{"count":8,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1888\/revisions"}],"predecessor-version":[{"id":1927,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1888\/revisions\/1927"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1888"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1888"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1888"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}