Diff: hal/analogout_api.h

Revision:

1:9db0e321a9f4

Parent:

0:5b88d5760320

--- a/hal/analogout_api.h	Tue Dec 17 23:23:45 2019 +0000
+++ b/hal/analogout_api.h	Tue Dec 31 06:02:27 2019 +0000
@@ -35,9 +35,42 @@
 
 /**
  * \defgroup hal_analogout Analogout hal functions
+ *
+ * # Defined behaviour
+ * * The function ::analogout_init initializes the dac_t control structure
+ * * The function ::analogout_write sets the output voltage, specified as a percentage (float) in range [0.0 (GND), 1.0 (VCC)]
+ * * The function ::analogout_write_u16 sets the output voltage, specified as unsigned 16-bit value [0 (GND), MAX_UINT16 (VCC)]
+ * * The function ::analogout_read reads the current voltage value on the pin and returns a floating-point value representing the current voltage in range [0.0 (GND), 1.0 (VCC)]
+ * * The function ::analogout_read_u16 reads the current voltage value on the pin and returns the output voltage, specified as unsigned 16-bit value [0 (GND), MAX_UINT16 (VCC)]
+ * * The accuracy of the DAC is +/- 10%
+ * * The DAC operations ::analogout_write, ::analogout_write_u16, ::analogout_read, ::analogout_read_u16 take less than 20us to complete
+ * * The function ::analogout_free releases the analogout object
+ *
+ * # Undefined behaviour
+ *
+ * * ::analogout_init is called with invalid pin (which does not support analog output function)
+ * * Calling other functions before ::analogout_init
  * @{
  */
 
+/**
+ * \defgroup hal_analogin_tests Analogout hal tests
+ * The Analogout HAL tests ensure driver conformance to defined behaviour.
+ *
+ * To run the Analogout hal tests use the command:
+ *
+ *     mbed test -t <toolchain> -m <target> -n tests-mbed_hal_fpga_ci_test_shield-analogout
+ *
+ */
+
+/** Initialize the analogout peripheral
+ *
+ * Configures the pin used by analogout.
+ * @param obj The analogout object to initialize
+ * @param pinmap pointer to structure which holds static pinmap
+ */
+void analogout_init_direct(dac_t *obj, const PinMap *pinmap);
+
 /** Initialize the analogout peripheral
  *
  * Configures the pin used by analogout.
@@ -48,7 +81,6 @@
 
 /** Release the analogout object
  *
- * Note: This is not currently used in the mbed-drivers
  * @param obj The analogout object
  */
 void analogout_free(dac_t *obj);