Diff: ad910x.h

Revision:

4:15b1cf1aa2b0

Parent:

3:909f157c982e

Child:

5:47508d73dad2

--- a/ad910x.h	Fri Mar 26 12:20:54 2021 +0000
+++ b/ad910x.h	Sat Apr 10 10:45:39 2021 +0000
@@ -1,3 +1,19 @@
+/******************************************************************************
+    @file:  ad910x.h
+ 
+    @brief: Defines digital pins and functions for the devices' SPI interface
+            and printing data from SPI read to text-based user interface
+-------------------------------------------------------------------------------
+    Copyright (c) 2021 Analog Devices, Inc.
+    All rights reserved.
+ 
+    This software is proprietary to Analog Devices, Inc. and its licensors.
+    By using this software you agree to the terms of the associated
+    Analog Devices Software License Agreement.
+ 
+    20210120-LWSC-CTSLA
+******************************************************************************/
+
 #ifndef __ad910x_h__
 #define __ad910x_h__
 
@@ -5,12 +21,12 @@
 {
     
     public:
-        SPI( spi );             ///< SPI instance of AD910x
-        DigitalOut( csb );      ///< DigitalOut instance for AD910x chip select
-        DigitalOut( resetb );   ///< DigitalOut instance for AD910x reset pin
-        DigitalOut( triggerb ); ///< DigitalOut instance for AD910x trigger pin
+        SPI( spi );             /// SPI instance of AD910x
+        DigitalOut( csb );      /// DigitalOut instance for AD910x chip select
+        DigitalOut( resetb );   /// DigitalOut instance for AD910x reset pin
+        DigitalOut( triggerb ); /// DigitalOut instance for AD910x trigger pin
  
-        /*** 4-Wire SPI configuration & constructor ***/
+        /*** 4-Wire SPI, Reset, and Trigger configuration & constructor ***/
         AD910x( PinName CSB = PG_10, PinName MOSI = PA_7, PinName MISO = PB_4, PinName SCK = PB_3,
                 PinName RESETB = PG_11, PinName TRIGGERB = PG_10 );