Merge pull request #6 from hepingood/dev

libdriver · web-flow · commit b0733005fe6f · 2023-02-05T09:52:41.000+08:00
style: fix some syntax errors
diff --git a/doc/html/driver__ds3231_8c_source.html b/doc/html/driver__ds3231_8c_source.html
@@ -292,7 +292,7 @@
 <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;        <span class="keywordflow">return</span> 1;                                                                                            <span class="comment">/* return error */</span></div>
 <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;    }</div>
 <div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;    res = a_ds3231_iic_write(handle, <a class="code" href="driver__ds3231_8c.html#a06321f1266d79561de07471199715896">DS3231_REG_MINUTE</a>, a_ds3231_hex2bcd(t-&gt;<a class="code" href="structds3231__time__s.html#a8ff981ec55c945940f4a0da7d8709b3c">minute</a>));                        <span class="comment">/* write minute */</span></div>
-<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;    <span class="keywordflow">if</span> (res != 0)                                                                                            <span class="comment">/* check reuslt */</span></div>
+<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;    <span class="keywordflow">if</span> (res != 0)                                                                                            <span class="comment">/* check result */</span></div>
 <div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;    {</div>
 <div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;        handle-&gt;<a class="code" href="structds3231__handle__s.html#a769d5b3a6c14790a0e126e8fe70b384b">debug_print</a>(<span class="stringliteral">&quot;ds3231: write minute failed.\n&quot;</span>);                                               <span class="comment">/* write minute failed */</span></div>
 <div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;        </div>
@@ -1085,9 +1085,9 @@
 <div class="line"><a name="l01249"></a><span class="lineno"> 1249</span>&#160;    }</div>
 <div class="line"><a name="l01250"></a><span class="lineno"> 1250</span>&#160;    *raw = (int16_t)(((uint16_t)buf[0]) &lt;&lt; 8) | buf[1];                                         <span class="comment">/* set raw temperature */</span></div>
 <div class="line"><a name="l01251"></a><span class="lineno"> 1251</span>&#160;    *raw = (*raw) &gt;&gt; 6;                                                                         <span class="comment">/* right shift */</span></div>
-<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span>&#160;    <span class="keywordflow">if</span> (((*raw) &amp; 0x0200) != 0)                                                                 <span class="comment">/* set negtive value */</span></div>
+<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span>&#160;    <span class="keywordflow">if</span> (((*raw) &amp; 0x0200) != 0)                                                                 <span class="comment">/* set negative value */</span></div>
 <div class="line"><a name="l01253"></a><span class="lineno"> 1253</span>&#160;    {</div>
-<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>&#160;        *raw = (*raw) | 0xFC00U;                                                                <span class="comment">/* set negtive part */</span></div>
+<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>&#160;        *raw = (*raw) | 0xFC00U;                                                                <span class="comment">/* set negative part */</span></div>
 <div class="line"><a name="l01255"></a><span class="lineno"> 1255</span>&#160;    }</div>
 <div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>&#160;    *s = (float)(*raw) * 0.25f;                                                                 <span class="comment">/* set converted temperature */</span></div>
 <div class="line"><a name="l01257"></a><span class="lineno"> 1257</span>&#160;    </div>
@@ -1487,7 +1487,7 @@
 <div class="line"><a name="l01803"></a><span class="lineno"> 1803</span>&#160;    info-&gt;<a class="code" href="structds3231__info__s.html#a9db82802561bf22d799b03a345f1d1dc">max_current_ma</a> = <a class="code" href="driver__ds3231_8c.html#a2989837a37d6d63b59c6dd541b785435">MAX_CURRENT</a>;                             <span class="comment">/* set maximum current */</span></div>
 <div class="line"><a name="l01804"></a><span class="lineno"> 1804</span>&#160;    info-&gt;<a class="code" href="structds3231__info__s.html#a3366a5dce9b829e03c3d321c2b4df3f6">temperature_max</a> = <a class="code" href="driver__ds3231_8c.html#a90c0b20d54005712fcc8cb01281360e9">TEMPERATURE_MAX</a>;                        <span class="comment">/* set minimal temperature */</span></div>
 <div class="line"><a name="l01805"></a><span class="lineno"> 1805</span>&#160;    info-&gt;<a class="code" href="structds3231__info__s.html#a8f9dbe66ac0b66ebae0a36fcb4ba368e">temperature_min</a> = <a class="code" href="driver__ds3231_8c.html#aab353db5bf4eb787f86a2080f609a551">TEMPERATURE_MIN</a>;                        <span class="comment">/* set maximum temperature */</span></div>
-<div class="line"><a name="l01806"></a><span class="lineno"> 1806</span>&#160;    info-&gt;<a class="code" href="structds3231__info__s.html#a41b0bd442708b70d252c50b92c75265a">driver_version</a> = <a class="code" href="driver__ds3231_8c.html#ae578001fe043b4cca7a0edd801cfe9c4">DRIVER_VERSION</a>;                          <span class="comment">/* set driver verison */</span></div>
+<div class="line"><a name="l01806"></a><span class="lineno"> 1806</span>&#160;    info-&gt;<a class="code" href="structds3231__info__s.html#a41b0bd442708b70d252c50b92c75265a">driver_version</a> = <a class="code" href="driver__ds3231_8c.html#ae578001fe043b4cca7a0edd801cfe9c4">DRIVER_VERSION</a>;                          <span class="comment">/* set driver version */</span></div>
 <div class="line"><a name="l01807"></a><span class="lineno"> 1807</span>&#160;    </div>
 <div class="line"><a name="l01808"></a><span class="lineno"> 1808</span>&#160;    <span class="keywordflow">return</span> 0;                                                       <span class="comment">/* success return 0 */</span></div>
 <div class="line"><a name="l01809"></a><span class="lineno"> 1809</span>&#160;}</div>
diff --git a/doc/html/group__ds3231__base__driver.html b/doc/html/group__ds3231__base__driver.html
@@ -750,7 +750,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga05b741038c591595714004c
 <li>1 set time failed</li>
 <li>2 handle or time is NULL</li>
 <li>3 handle is not initialized</li>
-<li>4 time is invalide </li>
+<li>4 time is invalid </li>
 </ul>
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_ds3231_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_ds3231_interface.c
@@ -45,7 +45,7 @@
 #define IIC_DEVICE_NAME "/dev/i2c-1"        /**< iic device name */
 
 /**
- * @brief iic device hanble definition
+ * @brief iic device handle definition
  */
 static int gs_fd;                           /**< iic handle */
 
diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c
@@ -109,7 +109,7 @@ uint8_t ds3231(uint8_t argc, char **argv)
         {"timestamp", required_argument, NULL, 5},
         {NULL, 0, NULL, 0},
     };
-    char type[33] = "unknow";
+    char type[33] = "unknown";
     char mode_name[32] = {0};
     uint32_t times = 3;
     uint32_t t = 0;
@@ -193,7 +193,7 @@ uint8_t ds3231(uint8_t argc, char **argv)
             /* enable */
             case 1 :
             {
-                /* set the enable */
+                /* set enable */
                 if (strcmp("true", optarg) == 0)
                 {
                     enable = DS3231_BOOL_TRUE;
@@ -1338,7 +1338,7 @@ int main(uint8_t argc, char **argv)
     }
     else
     {
-        ds3231_interface_debug_print("ds3231: unknow status code.\n");
+        ds3231_interface_debug_print("ds3231: unknown status code.\n");
     }
 
     return 0;
diff --git a/project/stm32f407/EW/stm32f407.dep b/project/stm32f407/EW/stm32f407.dep
@@ -5,12 +5,14 @@
     <configuration>
         <name>Release</name>
         <outputs>
-            <file>$PROJ_DIR$\..\usr\src\shell.c</file>
-            <file>$PROJ_DIR$\..\usr\src\stm32f4xx_hal_msp.c</file>
-            <file>$PROJ_DIR$\..\usr\src\stm32f4xx_it.c</file>
+            <file>$PROJ_DIR$\..\driver\src\stm32f407_driver_ds3231_interface.c</file>
+            <file>$PROJ_DIR$\..\..\..\src\driver_ds3231.c</file>
             <file>$PROJ_DIR$\..\usr\src\system_stm32f4xx.c</file>
-            <file>$PROJ_DIR$\..\usr\src\main.c</file>
+            <file>$PROJ_DIR$\..\usr\src\stm32f4xx_hal_msp.c</file>
             <file>$PROJ_DIR$\..\usr\src\getopt.c</file>
+            <file>$PROJ_DIR$\..\usr\src\main.c</file>
+            <file>$PROJ_DIR$\..\usr\src\stm32f4xx_it.c</file>
+            <file>$PROJ_DIR$\..\usr\src\shell.c</file>
         </outputs>
         <forcedrebuild>
             <name>[REBUILD_ALL]</name>
diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c
@@ -140,7 +140,7 @@ uint8_t ds3231(uint8_t argc, char **argv)
         {"timestamp", required_argument, NULL, 5},
         {NULL, 0, NULL, 0},
     };
-    char type[33] = "unknow";
+    char type[33] = "unknown";
     char mode_name[32] = {0};
     uint32_t times = 3;
     uint32_t t = 0;
@@ -224,7 +224,7 @@ uint8_t ds3231(uint8_t argc, char **argv)
             /* enable */
             case 1 :
             {
-                /* set the enable */
+                /* set enable */
                 if (strcmp("true", optarg) == 0)
                 {
                     enable = DS3231_BOOL_TRUE;
@@ -1341,7 +1341,7 @@ int main(void)
     /* uart init */
     uart_init(115200);
 
-    /* shell init && register ds3231 fuction */
+    /* shell init && register ds3231 function */
     shell_init();
     shell_register("ds3231", ds3231);
     uart_print("ds3231: welcome to libdriver ds3231.\n");
@@ -1364,7 +1364,7 @@ int main(void)
             }
             else if (res == 2)
             {
-                uart_print("ds3231: unknow command.\n");
+                uart_print("ds3231: unknown command.\n");
             }
             else if (res == 3)
             {
@@ -1380,7 +1380,7 @@ int main(void)
             }
             else
             {
-                uart_print("ds3231: unknow status code.\n");
+                uart_print("ds3231: unknown status code.\n");
             }
             uart_flush();
         }
diff --git a/src/driver_ds3231.c b/src/driver_ds3231.c
@@ -166,7 +166,7 @@ static uint8_t a_ds3231_bcd2hex(uint8_t val)
  *            - 1 set time failed
  *            - 2 handle or time is NULL
  *            - 3 handle is not initialized
- *            - 4 time is invalide
+ *            - 4 time is invalid
  * @note      none
  */
 uint8_t ds3231_set_time(ds3231_handle_t *handle, ds3231_time_t *t)
@@ -295,7 +295,7 @@ uint8_t ds3231_set_time(ds3231_handle_t *handle, ds3231_time_t *t)
         return 1;                                                                                            /* return error */
     }
     res = a_ds3231_iic_write(handle, DS3231_REG_MINUTE, a_ds3231_hex2bcd(t->minute));                        /* write minute */
-    if (res != 0)                                                                                            /* check reuslt */
+    if (res != 0)                                                                                            /* check result */
     {
         handle->debug_print("ds3231: write minute failed.\n");                                               /* write minute failed */
         
@@ -1249,9 +1249,9 @@ uint8_t ds3231_get_temperature(ds3231_handle_t *handle, int16_t *raw, float *s)
     }
     *raw = (int16_t)(((uint16_t)buf[0]) << 8) | buf[1];                                         /* set raw temperature */
     *raw = (*raw) >> 6;                                                                         /* right shift */
-    if (((*raw) & 0x0200) != 0)                                                                 /* set negtive value */
+    if (((*raw) & 0x0200) != 0)                                                                 /* set negative value */
     {
-        *raw = (*raw) | 0xFC00U;                                                                /* set negtive part */
+        *raw = (*raw) | 0xFC00U;                                                                /* set negative part */
     }
     *s = (float)(*raw) * 0.25f;                                                                 /* set converted temperature */
     
@@ -1803,7 +1803,7 @@ uint8_t ds3231_info(ds3231_info_t *info)
     info->max_current_ma = MAX_CURRENT;                             /* set maximum current */
     info->temperature_max = TEMPERATURE_MAX;                        /* set minimal temperature */
     info->temperature_min = TEMPERATURE_MIN;                        /* set maximum temperature */
-    info->driver_version = DRIVER_VERSION;                          /* set driver verison */
+    info->driver_version = DRIVER_VERSION;                          /* set driver version */
     
     return 0;                                                       /* success return 0 */
 }
diff --git a/src/driver_ds3231.h b/src/driver_ds3231.h
@@ -342,7 +342,7 @@ uint8_t ds3231_irq_handler(ds3231_handle_t *handle);
  *            - 1 set time failed
  *            - 2 handle or time is NULL
  *            - 3 handle is not initialized
- *            - 4 time is invalide
+ *            - 4 time is invalid
  * @note      none
  */
 uint8_t ds3231_set_time(ds3231_handle_t *handle, ds3231_time_t *t);

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ uint8_t ds3231(uint8_t argc, char **argv)`
`109`	`109`	`{"timestamp", required_argument, NULL, 5},`
`110`	`110`	`{NULL, 0, NULL, 0},`
`111`	`111`	`};`
`112`		`- char type[33] = "unknow";`
	`112`	`+ char type[33] = "unknown";`
`113`	`113`	`char mode_name[32] = {0};`
`114`	`114`	`uint32_t times = 3;`
`115`	`115`	`uint32_t t = 0;`
`@@ -193,7 +193,7 @@ uint8_t ds3231(uint8_t argc, char **argv)`
`193`	`193`	`/* enable */`
`194`	`194`	`case 1 :`
`195`	`195`	`{`
`196`		`- /* set the enable */`
	`196`	`+ /* set enable */`
`197`	`197`	`if (strcmp("true", optarg) == 0)`
`198`	`198`	`{`
`199`	`199`	`enable = DS3231_BOOL_TRUE;`
`@@ -1338,7 +1338,7 @@ int main(uint8_t argc, char **argv)`
`1338`	`1338`	`}`
`1339`	`1339`	`else`
`1340`	`1340`	`{`
`1341`		`- ds3231_interface_debug_print("ds3231: unknow status code.\n");`
	`1341`	`+ ds3231_interface_debug_print("ds3231: unknown status code.\n");`
`1342`	`1342`	`}`
`1343`	`1343`
`1344`	`1344`	`return 0;`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ uint8_t ds3231(uint8_t argc, char **argv)`
`140`	`140`	`{"timestamp", required_argument, NULL, 5},`
`141`	`141`	`{NULL, 0, NULL, 0},`
`142`	`142`	`};`
`143`		`- char type[33] = "unknow";`
	`143`	`+ char type[33] = "unknown";`
`144`	`144`	`char mode_name[32] = {0};`
`145`	`145`	`uint32_t times = 3;`
`146`	`146`	`uint32_t t = 0;`
`@@ -224,7 +224,7 @@ uint8_t ds3231(uint8_t argc, char **argv)`
`224`	`224`	`/* enable */`
`225`	`225`	`case 1 :`
`226`	`226`	`{`
`227`		`- /* set the enable */`
	`227`	`+ /* set enable */`
`228`	`228`	`if (strcmp("true", optarg) == 0)`
`229`	`229`	`{`
`230`	`230`	`enable = DS3231_BOOL_TRUE;`
`@@ -1341,7 +1341,7 @@ int main(void)`
`1341`	`1341`	`/* uart init */`
`1342`	`1342`	`uart_init(115200);`
`1343`	`1343`
`1344`		`- /* shell init && register ds3231 fuction */`
	`1344`	`+ /* shell init && register ds3231 function */`
`1345`	`1345`	`shell_init();`
`1346`	`1346`	`shell_register("ds3231", ds3231);`
`1347`	`1347`	`uart_print("ds3231: welcome to libdriver ds3231.\n");`
`@@ -1364,7 +1364,7 @@ int main(void)`
`1364`	`1364`	`}`
`1365`	`1365`	`else if (res == 2)`
`1366`	`1366`	`{`
`1367`		`- uart_print("ds3231: unknow command.\n");`
	`1367`	`+ uart_print("ds3231: unknown command.\n");`
`1368`	`1368`	`}`
`1369`	`1369`	`else if (res == 3)`
`1370`	`1370`	`{`
`@@ -1380,7 +1380,7 @@ int main(void)`
`1380`	`1380`	`}`
`1381`	`1381`	`else`
`1382`	`1382`	`{`
`1383`		`- uart_print("ds3231: unknow status code.\n");`
	`1383`	`+ uart_print("ds3231: unknown status code.\n");`
`1384`	`1384`	`}`
`1385`	`1385`	`uart_flush();`
`1386`	`1386`	`}`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ static uint8_t a_ds3231_bcd2hex(uint8_t val)`
`166`	`166`	`* - 1 set time failed`
`167`	`167`	`* - 2 handle or time is NULL`
`168`	`168`	`* - 3 handle is not initialized`
`169`		`- * - 4 time is invalide`
	`169`	`+ * - 4 time is invalid`
`170`	`170`	`* @note none`
`171`	`171`	`*/`
`172`	`172`	`uint8_t ds3231_set_time(ds3231_handle_t handle, ds3231_time_t t)`
`@@ -295,7 +295,7 @@ uint8_t ds3231_set_time(ds3231_handle_t handle, ds3231_time_t t)`
`295`	`295`	`return 1; /* return error */`
`296`	`296`	`}`
`297`	`297`	`res = a_ds3231_iic_write(handle, DS3231_REG_MINUTE, a_ds3231_hex2bcd(t->minute)); /* write minute */`
`298`		`- if (res != 0) /* check reuslt */`
	`298`	`+ if (res != 0) /* check result */`
`299`	`299`	`{`
`300`	`300`	`handle->debug_print("ds3231: write minute failed.\n"); /* write minute failed */`
`301`	`301`
`@@ -1249,9 +1249,9 @@ uint8_t ds3231_get_temperature(ds3231_handle_t handle, int16_t raw, float *s)`
`1249`	`1249`	`}`
`1250`	`1250`	`raw = (int16_t)(((uint16_t)buf[0]) << 8) \| buf[1]; / set raw temperature */`
`1251`	`1251`	`raw = (raw) >> 6; /* right shift */`
`1252`		`- if (((raw) & 0x0200) != 0) / set negtive value */`
	`1252`	`+ if (((raw) & 0x0200) != 0) / set negative value */`
`1253`	`1253`	`{`
`1254`		`- raw = (raw) \| 0xFC00U; /* set negtive part */`
	`1254`	`+ raw = (raw) \| 0xFC00U; /* set negative part */`
`1255`	`1255`	`}`
`1256`	`1256`	`s = (float)(raw) * 0.25f; /* set converted temperature */`
`1257`	`1257`
`@@ -1803,7 +1803,7 @@ uint8_t ds3231_info(ds3231_info_t *info)`
`1803`	`1803`	`info->max_current_ma = MAX_CURRENT; /* set maximum current */`
`1804`	`1804`	`info->temperature_max = TEMPERATURE_MAX; /* set minimal temperature */`
`1805`	`1805`	`info->temperature_min = TEMPERATURE_MIN; /* set maximum temperature */`
`1806`		`- info->driver_version = DRIVER_VERSION; /* set driver verison */`
	`1806`	`+ info->driver_version = DRIVER_VERSION; /* set driver version */`
`1807`	`1807`
`1808`	`1808`	`return 0; /* success return 0 */`
`1809`	`1809`	`}`