Changeset dcb74c0a in mainline

Timestamp:

2011-07-03T10:05:21Z (14 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

64e6945d

Parents:

8e1a819

Message:

Add function to str.c to convert space-padded ASCII to standard string
representation. Use for decoding SCSI strings.

Location:

uspace

Files:

• drv/bus/usb/usbmast/inquiry.c (modified) (2 diffs)
• drv/bus/usb/usbmast/mast.h (modified) (2 diffs)
• lib/c/generic/str.c (modified) (1 diff)
• lib/c/include/str.h (modified) (2 diffs)
• lib/scsi/include/scsi/spc.h (modified) (2 diffs)

uspace/drv/bus/usb/usbmast/inquiry.c

@@ -62 +62 @@
 }
 
-/** Trim trailing spaces from a string (rewrite with string terminator).
- *
- * @param name String to be trimmed (in-out parameter).
- */
-static void trim_trailing_spaces(char *name)
-{
-        size_t len = str_length(name);
-        while ((len > 0) && isspace((int) name[len - 1])) {
-                name[len - 1] = 0;
-                len--;
-        }
-}
-
 /** Perform SCSI INQUIRY command on USB mass storage device.
  *
@@ -126 +113 @@
             SCSI_RMB_RMB, SCSI_RMB_RMB);
 
-        str_ncpy(inquiry_result->vendor, 1 + sizeof(inq_data.vendor),
-            (const char *) &inq_data.vendor, sizeof(inq_data.vendor));
-        trim_trailing_spaces(inquiry_result->vendor);
+        spascii_to_str(inquiry_result->vendor, SCSI_INQ_VENDOR_STR_BUFSIZE,
+            inq_data.vendor, sizeof(inq_data.vendor));
 
-        str_ncpy(inquiry_result->product, 1 + sizeof(inq_data.product),
-            (const char *) &inq_data.product, sizeof(inq_data.product));
-        trim_trailing_spaces(inquiry_result->product);
+        spascii_to_str(inquiry_result->product, SCSI_INQ_PRODUCT_STR_BUFSIZE,
+            inq_data.product, sizeof(inq_data.product));
 
-        str_ncpy(inquiry_result->revision, 1 + sizeof(inq_data.revision),
-            (const char *) &inq_data.revision, sizeof(inq_data.revision));
-        trim_trailing_spaces(inquiry_result->revision);
+        spascii_to_str(inquiry_result->revision, SCSI_INQ_REVISION_STR_BUFSIZE,
+            inq_data.revision, sizeof(inq_data.revision));
 
         return EOK;

uspace/drv/bus/usb/usbmast/mast.h

@@ -37 +37 @@
 #define USB_USBMAST_MAST_H_
 
+#include <scsi/spc.h>
 #include <sys/types.h>
 #include <usb/usb.h>
@@ -52 +53 @@
         bool removable;
         /** Vendor ID string */
-        char vendor[9];
+        char vendor[SCSI_INQ_VENDOR_STR_BUFSIZE];
         /** Product ID string */
-        char product[17];
+        char product[SCSI_INQ_PRODUCT_STR_BUFSIZE];
         /** Revision string */
-        char revision[17];
+        char revision[SCSI_INQ_REVISION_STR_BUFSIZE];
 } usb_massstor_inquiry_result_t;
 

uspace/lib/c/generic/str.c

@@ -544 +544 @@
         
         str_cpy(dest + dstr_size, size - dstr_size, src);
+}
+
+/** Convert space-padded ASCII to string.
+ *
+ * Common legacy text encoding in hardware is 7-bit ASCII fitted into
+ * a fixed-with byte buffer (bit 7 always zero), right-padded with spaces
+ * (ASCII 0x20). Convert space-padded ascii to string representation.
+ *
+ * If the text does not fit into the destination buffer, the function converts
+ * as many characters as possible and returns EOVERFLOW.
+ *
+ * If the text contains non-ASCII bytes (with bit 7 set), the whole string is
+ * converted anyway and invalid characters are replaced with question marks
+ * (U_SPECIAL) and the function returns EIO.
+ *
+ * Regardless of return value upon return @a dest will always be well-formed.
+ *
+ * @param dest          Destination buffer
+ * @param size          Size of destination buffer
+ * @param src           Space-padded ASCII.
+ * @param n             Size of the source buffer in bytes.
+ *
+ * @return              EOK on success, EOVERFLOW if the text does not fit
+ *                      destination buffer, EIO if the text contains
+ *                      non-ASCII bytes.
+ */
+int spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n)
+{
+        size_t sidx;
+        size_t didx;
+        size_t dlast;
+        uint8_t byte;
+        int rc;
+        int result;
+
+        /* There must be space for a null terminator in the buffer. */
+        assert(size > 0);
+        result = EOK;
+
+        didx = 0;
+        dlast = 0;
+        for (sidx = 0; sidx < n; ++sidx) {
+                byte = src[sidx];
+                if (!ascii_check(byte)) {
+                        byte = U_SPECIAL;
+                        result = EIO;
+                }
+
+                rc = chr_encode(byte, dest, &didx, size - 1);
+                if (rc != EOK) {
+                        assert(rc == EOVERFLOW);
+                        dest[didx] = '\0';
+                        return rc;
+                }
+
+                /* Remember dest index after last non-empty character */
+                if (byte != 0x20)
+                        dlast = didx;
+        }
+
+        /* Terminate string after last non-empty character */
+        dest[dlast] = '\0';
+        return result;
 }
 

uspace/lib/c/include/str.h

@@ -48 +48 @@
 #define STR_BOUNDS(length)  ((length) << 2)
 
+/**
+ * Maximum size of a buffer needed to a string converted from space-padded
+ * ASCII of size @a spa_size using spascii_to_str().
+ */
+#define SPASCII_STR_BUFSIZE(spa_size) ((spa_size) + 1)
+
 extern wchar_t str_decode(const char *str, size_t *offset, size_t sz);
 extern int chr_encode(const wchar_t ch, char *str, size_t *offset, size_t sz);
@@ -73 +79 @@
 extern void str_append(char *dest, size_t size, const char *src);
 
+extern int spascii_to_str(char *dest, size_t size, const uint8_t *src, size_t n);
 extern void wstr_to_str(char *dest, size_t size, const wchar_t *src);
 extern char *wstr_to_astr(const wchar_t *src);

uspace/lib/scsi/include/scsi/spc.h

@@ -38 +38 @@
 
 #include <stdint.h>
+#include <str.h>
 
 /** SCSI command codes defined in SCSI-SPC */
@@ -93 +94 @@
 } scsi_std_inquiry_data_t;
 
+/** Size of struct or union member. */
+#define SCSI_MEMBER_SIZE(type, member) \
+    (sizeof(((type *)0) -> member))
+
+/** Size of string buffer needed to hold converted inquiry vendor string */
+#define SCSI_INQ_VENDOR_STR_BUFSIZE \
+    SPASCII_STR_BUFSIZE(SCSI_MEMBER_SIZE(scsi_std_inquiry_data_t, vendor))
+
+/** Size of string buffer needed to hold converted inquiry product string */
+#define SCSI_INQ_PRODUCT_STR_BUFSIZE \
+    SPASCII_STR_BUFSIZE(SCSI_MEMBER_SIZE(scsi_std_inquiry_data_t, product))
+
+/** Size of string buffer needed to hold converted inquiry revision string */
+#define SCSI_INQ_REVISION_STR_BUFSIZE \
+    SPASCII_STR_BUFSIZE(SCSI_MEMBER_SIZE(scsi_std_inquiry_data_t, revision))
+
 /** Bits in scsi_std_inquiry_data_t.pqual_devtype */
 enum scsi_pqual_devtype_bits {