drivers: fpga: change retval description

msierszulski · MaureenHelm · commit e0274e2c5419 · 2022-04-08T09:11:08.000-05:00
This commit fixes the description of the values
returned by the get_status() function.

Signed-off-by: Mateusz Sierszulski &lt;msierszulski@antmicro.com&gt;
diff --git a/include/drivers/fpga.h b/include/drivers/fpga.h
@@ -48,8 +48,8 @@ __subsystem struct fpga_driver_api {
  *
  * @param dev FPGA device structure.
  *
- * @retval 0 if the FPGA is in ACTIVE state.
- * @retval 1 if the FPGA is in INACTIVE state.
+ * @retval 0 if the FPGA is in INACTIVE state.
+ * @retval 1 if the FPGA is in ACTIVE state.
  */
 static inline enum FPGA_status fpga_get_status(const struct device *dev)
 {

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ __subsystem struct fpga_driver_api {`
`48`	`48`	`*`
`49`	`49`	`* @param dev FPGA device structure.`
`50`	`50`	`*`
`51`		`- * @retval 0 if the FPGA is in ACTIVE state.`
`52`		`- * @retval 1 if the FPGA is in INACTIVE state.`
	`51`	`+ * @retval 0 if the FPGA is in INACTIVE state.`
	`52`	`+ * @retval 1 if the FPGA is in ACTIVE state.`
`53`	`53`	`*/`
`54`	`54`	`static inline enum FPGA_status fpga_get_status(const struct device *dev)`
`55`	`55`	`{`