occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

ad9910: Add bitsizes to docstrings (#2505) 

Co-authored-by: architeuthidae <am@m-labs.hk>
This commit is contained in:
architeuthidae 2024-07-22 18:37:43 +08:00 committed by Sébastien Bourdeauducq
parent d7e78aded3
commit cd12600c1c
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
artiq/coredevice/ad9910.py
View File

@ -390,7 +390,7 @@ class AD9910:
manual_osk_external: TInt32 = 0, manual_osk_external: TInt32 = 0,
osk_enable: TInt32 = 0, osk_enable: TInt32 = 0,
select_auto_osk: TInt32 = 0): select_auto_osk: TInt32 = 0):
"""Set CFR1. See the AD9910 datasheet for parameter meanings. """Set CFR1. See the AD9910 datasheet for parameter meanings and sizes.
This method does not pulse ``IO_UPDATE.`` This method does not pulse ``IO_UPDATE.``
@ -429,7 +429,7 @@ class AD9910:
effective_ftw: TInt32 = 1, effective_ftw: TInt32 = 1,
sync_validation_disable: TInt32 = 0, sync_validation_disable: TInt32 = 0,
matched_latency_enable: TInt32 = 0): matched_latency_enable: TInt32 = 0):
"""Set CFR2. See the AD9910 datasheet for parameter meanings. """Set CFR2. See the AD9910 datasheet for parameter meanings and sizes.
This method does not pulse ``IO_UPDATE``. This method does not pulse ``IO_UPDATE``.
@ -617,12 +617,12 @@ class AD9910:
profile: TInt32 = _DEFAULT_PROFILE_RAM, profile: TInt32 = _DEFAULT_PROFILE_RAM,
nodwell_high: TInt32 = 0, zero_crossing: TInt32 = 0, nodwell_high: TInt32 = 0, zero_crossing: TInt32 = 0,
mode: TInt32 = 1): mode: TInt32 = 1):
"""Set the RAM profile settings. """Set the RAM profile settings. See also AD9910 datasheet.
:param start: Profile start address in RAM. :param start: Profile start address in RAM (10-bit).
:param end: Profile end address in RAM (last address). :param end: Profile end address in RAM, inclusive (10-bit).
:param step: Profile time step in units of t_DDS, typically 4 ns :param step: Profile time step, counted in DDS sample clock
(default: 1). cycles, typically 4 ns (16-bit, default: 1)
:param profile: Profile index (0 to 7) (default: 0). :param profile: Profile index (0 to 7) (default: 0).
:param nodwell_high: No-dwell high bit (default: 0, :param nodwell_high: No-dwell high bit (default: 0,
see AD9910 documentation). see AD9910 documentation).