; $URL: http://subversion:8080/svn/gsc/trunk/drivers/LINUX/16AI32SSC/doc/release.txt $
; $Rev: 54773 $
; $Date: 2024-07-01 18:05:34 -0500 (Mon, 01 Jul 2024) $

16AI32SSC: Linux Driver Release Notes

Revision History
================

--------------------------------------------------------------------------------

Version 2.8.111.50.0, Released 7/1/2024

driver: Updated the PIO and DMA threshold values based on testing.
driver: Updated for Fedora 38.
driver: Removed LL Control Register, LL Hold and LL Release as they are not in firmware.
driver: Corrected the operation of the LL Read IOCTL service.
driver: Corrected error message text.
driver: Added support for the Tundra TSI381, which is equivalent to the PLX PXI8111.
driver: Updated the Rx Debug support.
driver: Remove Red Hat 8 compiler warning (2.4 kernel).
driver: Corrected log message when excusive open request fails.
driver: White space cleanup.
driver: Fixed an issue where the register id is zero (for testing purposes).
driver: Updated and expanded error reporting.
driver: LINTed the sources for the 2.4 kernel builds.
driver: LINTed sources.
driver: Updated to address Fedora 38 complaints.

--------------------------------------------------------------------------------

Version 2.7.104.47.0, Released 9/7/2023

NOTE: The last argument for ai32ssc_config_ai() has been changed from "nrate"
to "fsamp". This was done for consistency with our other Linux drivers.

driver: Updated to support the 6.x series kernel.
driver: Renamed all Auto_Cal content to Autocal.
driver: Added PIO and BMDMA Threshold IOCTL services for performance testing.
driver: Updated the Initialize IOCTL service for consistency.
driver: Updated the Autocalibration IOCTL service for consistency.
driver: Updated the Input Buffer Clear IOCTL service for consistency.
driver: Added RX DEBUG capabilities.
driver: Updated comments for consistency.
driver: Added global driver unloading flag.
driver: Added "unloading" message when unload service is called.
driver: Updated for changes after the 5.17.15 kernel.
driver: Updated to support the 6.x kernel.
driver: Updated some comments for consistency.
driver: White space cleanup.
driver: Updated for changes to Red Hat Enterprise Linux 8.6.

--------------------------------------------------------------------------------

Version 2.6.100.42.0, Released 7/12/2022

driver: Updated comments for consistency.
driver: Updated display output for consistency.
driver: Update to some error processing.
driver: Updated to support segregation of PLX specific sources.
driver: Removed unintended debug output statements.
driver: Renamed gsc_irq_reset_pci to gsc_irq_cpi_reset for consistency.
driver: Segregated additional PLX specific code.
driver: Updated system message to begin with the driver module name.
driver: Began implementation for MSI support.
driver: Segregated all PLX specific code to accommodate alternate device implementations.
driver: Added the os_irq_t.created field.
driver: Updated os_irq_create, destroy, open and close services.
driver: Removed unused debugging messages.
driver: Began implementing MSI support.
driver: Added macro DEV_IRQ_SHOW to report assigned IRQ assigned to device.
driver: Removed unused macros.
driver: Updated for the 5.14 kernel.

--------------------------------------------------------------------------------

Version 2.5.97.38.0, Released 3/17/2022

driver: Updated the Initialize IOCTL service to include waiting on the IRQ.
driver: Reorganized some structure content for consistency and clarity.
driver: Updated I/O initialization for consistency and clarity.
driver: White space cleanup.
driver: Updated some comments.
driver: Updated debugging display output.

--------------------------------------------------------------------------------

Version 2.4.96.38.0, Released 1/17/2022

driver: Added support for the 5.x kernel series.
driver: Removed compiler warnings for Fedora 31.
driver: Updated initial file content for consistency.
driver: Updated for porting to Windows.
driver: Standardized various IOCTL system log messages.
driver: Standardized processing of the initialization IOCTL service.
driver: Standardized processing of the autocalibration IOCTL service.
driver: LINTed sources.
driver: Added temporary experimental write code in gsc_write.c for performance testing.
driver: The code is partially retained but is not included for compilation.
driver: Fixed a DMA bug relating to the use of a timeout setting of zero.
driver: Corrected endian error message.
driver: Fixed a timeout bug in gsc_write_pio_work_32_bit().
driver: Updated IRQ code for improved clarity and modularity.
driver: Updated DMA code to support multiple DMA implementations.
driver: Removed I/O debug code.
driver: Removed compiler warnings under Windows.
driver: Fixed a IOCTL bug in which alt->sem wasn't being unlocked.
driver: Increased modularization for porting effort to another OS.
driver: Made DMA code more modular.
driver: Added support for Big Endian hosts.
driver: Updated per OS specific DMA memory allocation interface.
driver: Made spelling corrections in version notes.
driver: Changed all printk instances to printf to support porting activities.
driver: Expanded files removed for a clean operation.
driver: Updated to support the 5.9 kernel.
driver: Modified os_common.h so application code compiles under Cygwin.
driver: Reduced the minimum tick sleep from 1 to 0 ticks.
driver: Modified debug specific register access code to enhance usage.
driver: Improved Red Hat Enterprise Linux 8.x detection logic.
driver: Added support under the 4.x kernel for Red Hat Enterprise Linux 8.x.
driver: Added validation checking of the interrupt number in os_irq_open().
driver: Updated the /proc/ code for changes in the 5.6.6 kernel.
driver: Updated memory code for improved clarity and modularity.
driver: Code cleanup in open service.
driver: Fixed open bug applicable to multi-board devices.
driver: Made mods to accommodate porting to another OS.
driver: Added DMA support for an IOMMU.
driver: Added error reporting when DMA memory could not be allocated.
driver: Reduced code included when read and write are both unsupported.
driver: Added error reporting when IRQ could not be acquired during open requests.
driver: Some minor code reorganization.

--------------------------------------------------------------------------------

Version 2.3.85.27.0, Released 5/3/2019

driver: Fixed bug in gsc_dma_perform(): timeouts were being ignored.
driver: Fixed bug in gsc_dma_perform(): the timeout detection logic was incorrect.
driver: Improved register validation.
driver: Subsystem Vendor ID and Subsystem ID can each be ignored if -1 in device table.
driver: #define for GSC_REG_ENCODE_MASK is moved here from gsc_reg.c.
driver: Enhanced error reporting for the process of validating register definitions.
driver: Fixed bug in DMA completion code.
driver: Updated initialization for the write service.
driver: Updated BAR creation logic.

--------------------------------------------------------------------------------

Version 2.3.81.26.0, Released 10/25/2018

driver: Modified code so open succeeds even if initialization fails.
driver: Added Low Latency support.
driver: Updated per changes to common code.
driver: Updated muti-channel ISR code for new I/O streams structure.
driver: DEV_WAIT_IO_ALL is now required if WAIT is supported along with READ or WRITE
driver: I/O WAIT macros are now defined by the device API and are passed to GSC code in dev_io_t.
driver: Updated Block Mode DMA macro name (_DMA to _BMDMA).
driver: Added I/O, DMA and register access debug code.
driver: Added stream selection field in the "size" argument for the read and writecalls.
driver: Added OS IRQ calls: os_irq_create() and os_irq_destroy()
driver: Renamed field in gsc_irq_t for clarity.
driver: Fixed a bug in which wait list node removal didn't always have the list locked.
driver: Added support for some DMA metrics.
driver: Improved IOCTL argument validation.
driver: Moved a typedef to device specific code.
driver: Udated some utility services: applying a setting, end by reading it back
driver: Implemented support for a stream selection field in the I/O bytes argument.
driver: Implemented register access debug code.
driver: Implemented calls: os_irq_create() and os_irq_destroy()
driver: Field in gsc_irq_t renamed for clarity.
driver: Changed macro name for clarity.

--------------------------------------------------------------------------------

Version 2.2.74.21.0, Released 3/1/2018

driver: Modified how the last query service value is defined.
driver: Bug fix: was ignoring BAR setup return value.
driver: Updated per changes to the OS specific PCI services.
driver: Made updates for DEV_SUPPORTS_XXX macro changes.
driver: Updated initial file content for consistency.
driver: Updated AI32SSC_QUERY_COUNT processing.
driver: Added NOTPARALLEL to the makefile.
driver: Updated for support of some drivers under older kernels.
driver: Updated #include file for consistancy.
driver: Fixed a DMA timeout calculation bug.
driver: Updated to accommodate porting to Windows KMDF.
driver: Updated per changes to the low level register interface.
driver: Updated the driver initialization logic.
driver: Updated IOCTL init and reset code.
driver: Added support to exclude the WAIT feature.
driver: Updated macros to include/exclude IRQ support.
driver: Fixed bug in init code where last PCI device is one of ours.
driver: Updated to accomodate Fedora 27.
driver: Updated the low level register interface.

--------------------------------------------------------------------------------

Version 2.1.68.18.0, Released 11/28/2016

driver: The BAR code has been updated to include the data under a single structure.
driver: The register definitions have been updated.
driver: I/O services now pass around an os_mem_t structure instead of a buffer pointer.
driver: White space cleanup.
driver: Changed the arbitrary wait event callback argument to a void* type.
driver: Modified to allow multiple apps to simultaneously access a single device.
driver: Correct access to BAR0 and BAR1 (is RO, was RW).
driver: Added an infinite I/O timeout option.
driver: Corrected the IOCTL code for the register write and mod services.
driver: Added special case for register I/O where register id value is 0.
driver: Added support for inifinite I/O timeout.
driver: Improved response to being signalled (i.e. being told to abort).
driver: An event wait timeout value of zero now means do not timeout.
driver: Fixed an I/O bug.
driver: Updated the version number macros.
driver: Updated the format and encoding of register macros.
driver: Fixed DMA bug.
driver: Moved some BAR functionality to the OS specific code.
driver: I/O now passes around an os_mem_t structure instead of a buffer pointer.
driver: Copying to and from user space is now done with more use specific routines.
driver: Made more ISR functionality subject to the GSC_IRQ_ISR_FLAG_DETECT_ONLY flag.
driver: Dropped I/O register access services.
driver: Performed some LINTing.
driver: Simplified error messages.
driver: Fixed ul2hex().
driver: Added special case handling for reads of register id value 0.
driver: Added support for reporting metrics information during driver installation.
driver: Removed use of function check_mem_region() in 4.x kernels.
driver: Implemented support for the 4.x kernels.
driver: Added checks on some pointers before using them.
driver: Added safety check in EVENT_RESUME_IRQ().
driver: Removed unused macro (OS_CAST_VOIDP_TO_U32).
driver: Moved some BAR functionality here from more common code.
driver: Renamed os_event_cleanup() to os_event_destroy().
driver: Simplified use of os_mem_t structures and content.


--------------------------------------------------------------------------------

Version 2.0.62.10.0, Released 10/1/2015

driver: The macro S32_MAX is defined only if not already done so.
driver: Added the utility service ul2hex().
driver: Changed register offsets to u16 from unsigned long.
driver: Changed printk's to printf's.
driver: Removed an RTX compiler warning in gsc_poll_u32.
driver: Made ISR access more OS agnostic.
driver: Made PCI registers accessible from inside an ISR.
driver: Added gsc_wait_resume_irq_io() for use by the ISR.
driver: Removed the use of __DATE__ and __TIME__.
driver: Made ISR access more OS agnostic.
driver: Made PCI registers accessible from inside an ISR.

--------------------------------------------------------------------------------

Version 2.0.60.8.0, Released 9/11/2015

rxrate: Updated the displayed output.
rxrate: Added the -s command line argument.

--------------------------------------------------------------------------------

Version 2.0.59.7.0, Released 7/21/2015

driver: Updated to use the newer common driver sources.
driver: Removed GNU notice from non-Linux specific files.
driver: Removed Linux specific content from non-Linux specific source files.
driver: Now using a spinlock rather than enabling and disabling interrupts.
driver: Updated gsc_irq_open() and gsc_irq_close().
driver: Updated gsc_dma_open() and gsc_dma_close().
docsrc: Updated per changes to the device node name, which is now /dev/<device>.X.
sbtest: Updated per a register name change.
LINTed various sources.
White space cleanup.

--------------------------------------------------------------------------------

Version 1.14.52.0, Released 2/26/2014

Driver: Reduced #include list in driver interface header.
Additional LINTing.
White space cleanup.

--------------------------------------------------------------------------------

Version 1.13.51.0, Released 1/8/2014

Driver: Modified the conditional definition of flags used by kmalloc().
Driver: Updated /proc file support for the 3.10 kernel changes.
Driver: Additional porting for the 2.2 kernel.

--------------------------------------------------------------------------------

Version 1.13.45.0, Released 7/3/2013

Driver: Freeing the board interrupt is now conditioned upon it being acquired.
Driver: Corrected definition of register GSC_PLX_9056_PABTADR.
Driver: Added support for the Bus Abort interrupt.
Driver: Updated DMA reads to improve performance.
Driver: Changed how I/O buffers are allocated.
Driver: Changed how s8 ... u32 are included.
Driver: Enhanced the IOCTL service code to accommodate unsupported services.
Driver: Updated the BAR mapping failure messages.
Driver: Added s8 ... u32 definitions for application use.
Driver: Updated gsc_dma_destroy() - now zero fills memory when done.
Driver: Updated gsc_irq_destroy() - does cleanup when done.

--------------------------------------------------------------------------------

Version 1.13.39.0, Released 7/18/2012

Driver: Corrected a jiffies roll over bug in ioctl.c.
Driver: Added support for boards that need additional setup after a DMA channel has been selected.
Driver: Made the IOCTL buffer larger - 512 bytes.
Updated the parameter list to gsc_id_driver().

--------------------------------------------------------------------------------

Version 1.12.37.0, Released 5/2/2012

Driver: Updated for the 3.x kernel.
Driver: Added the AI32SSC_IOCTL_RBG_SYNC_OUTPUT IOCTL service.
Driver: Added the AI32SSC_QUERY_RBG_SYNC_OUTPUT QUERY option.
Driver: Added the AI32SSC_QUERY_LOW_LATENCY QUERY option.
Driver: Updated supported master clock frequescies. Added 40000000 and 48000000.
id: Added support for: Low Latency, Rage-B Gen SYNC Output
sbtest: Added support for: Rage-B Gen SYNC Output
signals: Updated the signal output generation code.
signals: Added support for the Rate-B Generator SYNC Output option.

--------------------------------------------------------------------------------

Version 1.11.34.0, Released 12/21/2011

Driver: BAR0 and BAR2 are now the only BAR regions used.
Driver: All common driver sources are included though not all are used.
id: Corrected output spelling.
signals: Corrected output spelling.
tt: Corrected output spelling.
Split the utility code into two libraries: common and device specific.

--------------------------------------------------------------------------------

Version 1.10.30.0, Released 10/28/2011

Driver: Modified driver start script to correct messages under Ubuntu.
Driver: Added GSC_IRQ_NOT_USED macro to hide interrupt servicing.
Driver: Fixed a bug in the GSC_INTCSR_MAILBOX_INT_ACTIVE macro.
Driver: Added #defines for D0 through D31.
Driver: Modified gsc_sem_t to prevent hanging on an uninitialized structure.
Driver: Added support for deprication of file_ops.ioctl.
Driver: Started PLX EEPROM access support.
Driver: Modified so BAR2 can now be memory or I/O mapped.
Driver: Corrected the _1M macro.
Driver: Eliminated the global dev_check_id() routine.
Modified makefiles to correct messages under Ubuntu.
Removed compiler warnings under Fedora 15.

--------------------------------------------------------------------------------

Version 1.9.22.0, Released 3/1/2011

Driver: Added ISR support for pre-005 firmware.
Driver: Fixed the IRQ0 and IRQ1 Select IOCTL services for pre-005 firmware.

--------------------------------------------------------------------------------

Version 1.8.21.0, Released 1/7/2011

Driver: Corrected a compile bug for Fedora 7.
Driver: Removed compiler warning in Fedora 12: reduced module_init stack usage.
Driver: Removed remove_proc_entry() call from proc_start - fix for Fedora 14.
Driver: Fixed a bug in gsc_ioctl_init().

--------------------------------------------------------------------------------

Version 1.7.18.0, Released 11/5/2010

Driver: Corrected the periods allotted for an Autocal and for Initialize.
Driver: Corrected a bug in Input Buffer Threshold Status service.
sbtest: Updated Time Tag testing.

--------------------------------------------------------------------------------

Version 1.6.18.0, Released 9/20/2010

Driver: Updated the set of IOCTL services.
Driver: Implemented support for the common PIO I/O routines.
Driver: Initialize now also resets software settings.
sbtest: Moved the interrupt tests from irq0_sel.c and irq1.c to wait_event.c
sbtest: Implemented the Scan Marker Value test.
Updated numerous sources per changes in the set of supported IOCTL services.
Updated various Auto Cal related strings and macros for consistency.

--------------------------------------------------------------------------------

Version 1.5.17.0, Released 7/2/2010

Driver: Made Init and Autocal more robust.
Driver: Fixed bug in I/O Abort service.
Driver: Fixed AI32SSC_IOCTL_TT_CHAN_MASK definition.
sbtest: made a few updates.

--------------------------------------------------------------------------------

Version 1.4.17.0, Released 6/24/2010

Driver: Added WAIT IOCTL services.
Driver: Updated interrupt support.
updated the sample applications per the changes to the driver.
Added Time Tag (tt) sample application.
Added Signals (signals) sample application.

--------------------------------------------------------------------------------

Version 1.3.13.0, Released 12/24/2009

Driver Version: 1.2.13
Driver: Modified the EVENT_WAIT_IRQ_TO() macro for the 2.6 kernel.
Driver: Corrected a bug in the AI32SSC_IOCTL_AIN_BUF_CLEAR service.

--------------------------------------------------------------------------------

Version 1.2.11.0, Released 11/20/2009

Driver Version: 1.2.11
Driver: Updated driver read services to use common data types.
Driver: Removed color code from the driver start script.
Driver: Fixed a typo/bug in dma_read_available.
Driver: Fixed a bug in the Scan Marker IOCTL service.
sbtest: Fixed a bug in the Scan Marker IOCTL service.

--------------------------------------------------------------------------------

Version 1.1.6.0, Released 4/24/2009

Driver Version: 1.1.6
Added dev_check_id() for more detailed device identification. This was added
  to help distinguish the 16AI32SSC from devices using the same subsystem id.

--------------------------------------------------------------------------------

Version 1.0.5.0, Released 4/17/2009

Driver Version: 1.0.5
Fixed a DMA bug: the first DMA returned incorrect data
Added support for some new board types (gsc_main.h).
Modified some PLX register names for consistency.
Updated some utility sources.

--------------------------------------------------------------------------------

Version 1.0.3.1, Released 4/17/2009

Driver Version: 1.0.3
This was released with an incorrect version number.

--------------------------------------------------------------------------------

Version 1.0.3.0, Released 3/29/2009

Driver Version: 1.0.3
Initial release.

--------------------------------------------------------------------------------
