; $URL: http://subversion:8080/svn/gsc/trunk/drivers/LINUX/ADADIO/ADADIO_Linux_3.x.x.x_GSC_DN/doc/release.txt $
; $Rev: 55461 $
; $Date: 2024-09-27 12:17:25 -0500 (Fri, 27 Sep 2024) $

ADADIO: Linux Driver Release Notes

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

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

Version 4.10.111.50.0, Released 9/27/2024

driver: Updated to support the 6.x series kernel.
driver: Updated for Fedora 38.
driver: Renamed Auto_Cal* content to Autocal.
driver: Corrected error message text.
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: Added RX DEBUG capabilities.
driver: Updated comments for consistency.
driver: Corrected a comment.
driver: LINTed the sources for the 2.4 kernel builds.
driver: LINTed sources.
driver: Updated to address Fedora 38 complaints.
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.

utils: Removed the prefix "utils_" from the source files.

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

Version 4.9.102.44.0, Released 1/30/2023

driver: Updated comments for consistency.
driver: Updated the Initialize and Autocal IOCTL services for consistency.
driver: Deleted unused macros.
driver: Updated per PLX code segregation.
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: Updated some comments for consistency.
driver: White space cleanup.
driver: Updated for changes to Red Hat Enterprise Linux 8.6.
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 4.8.97.38.0, Released 3/8/2022

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: Fiaxed bugs in the DIO Pin read and write services.
driver: Updated debugging display output.
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: 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.

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

Version 4.7.90.30.1, Released 1/28/2020

sbtest: updated tests for the ADADIO2 device.

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

Version 4.7.90.30.0, Released 1/20/2020

driver: Corrected ADADIO2 detection method.
driver: Removed compiler warnings under Windows.
driver: Code cleanup in open service.

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

Version 4.6.89.29.0, Released 12/5/2019

driver: Added support for the ADADIO2.
driver: Corrected the definition of the BRR register macro.
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: Fixed 9060 Endian support bug.
driver: Fixed open bug applicable to multi-device products.
driver: Made mods to accomodate porting to another OS.

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

Version 4.5.86.28.0, Released 6/25/2019

driver: Added support for the 5.x kernel series.
driver: Added Endianness support.
driver: Removed duplicate spinlock initialization code.
driver: Modified the last query option value macro.
driver: Added support for Big Endian hosts.
driver: Updated per OS specific DMA memory allocation interface.
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: Added DMA support for an IOMMU.
driver: Added error reporting when DMA memory cound not be allocated.
driver: Reduced code included when read and writ are both unsupported.
driver: Added error reporting when IRQ cound not be acquired during open requests.
driver: Some minor code reorganization.
driver: Updated BAR creation logic.

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

Version 4.4.81.26.0, Released 2/7/2019

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: Modified code so open succeeds even if initialization fails.
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: Updated for support of some drivers under older kernels.
driver: Updated #include files for consistancy.
driver: Fixed a DMA timeout calculation bug.
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: 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.
driver: Updated to accomodate Fedora 27.
driver: Updated the low level register interface.

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

Version 4.3.68.18.0, Released 12/5/2016

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: 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.

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

Version 4.2.66.14.0, Released 6/9/2016

driver: Added the ADADIO_IOCTL_AIN_BUF_ENABLE service.
driver: Added safety check in EVENT_RESUME_IRQ().

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

Version 4.1.66.13.0, Released 5/4/2016

driver: White space cleanup.
driver: Updated BAR mapping support.
driver: Updated wait event argument types.
driver: Removed the "built" entry from the /proc file.
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: 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: Made ISR access more OS agnostic.
driver: Made PCI registers accessible from inside an ISR.
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: Copying to and from user space is now done with more use specific routines.
driver: Simplified use of os_mem_t structures and content.
driver: Simplified error messages.
driver: Removed the use of __DATE__ and __TIME__.

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

Version 4.0.60.8.0, Released 9/16/2015

driver: Modified to use more of the newer common sources.
driver: Minor update the DMA Read data availability service.
driver: Updated to use the newer common driver sources.
driver: Reading and caching of the BRR to now done when the driver is loaded.
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.
aout: Renamed one or more variables.
din: Renamed one or more variables.
dout: Renamed one or more variables.
rxrate: Renamed one or more variables.
rxrate: Updated the displayed output.
rxrate: Deleted the -s# command line argument.
rxrate: Added the -r# command line argument.
LINTed various sources.
White space cleanup.

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

Version 3.8.55.0, Released 9/4/2014

driver: The initialization routine no longer uses interrupts.
driver: Device open requests ignore initialization failures.
driver: Removed dead code (i.e. excluded by #if 0).
driver: Removed additional compiler warnings.
driver: Additional LINTing.

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

Version 3.7.52.0, Released 2/28/2014

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

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

Version 3.6.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 3.6.48.0, Released 11/6/2013

Driver: The IOCTL command code is now treated as an integer.
Driver: Additional LINTing of the sources.
testapp: removed from release.
Updated the usage output.
Minor amount of LINTing.
Some output to the screen is flushed as needed.

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

Version 3.6.45.0, Released 7/16/2013

Driver: Freeing the device 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 3.6.39.0, Released 7/23/2012

Driver: Updated for the 3.x kernel.
Driver: Corrected a jiffies roll over bug in ioctl.c.
Driver: Removed compile warnings from the copy_from_user_ret macro.
Updated the makefile for consistency.
Updated the parameter list to gsc_id_driver().

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

Version 3.5.34.0, Released 12/20/2011

Driver: BAR0 and BAR2 are now the only BAR regions used.
Driver: Include all common sources, though not all are used.
Split the utility code into two libraries: common and device specific.
Updated the utils interface for consistency.

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

Version 3.4.32.0, Released 11/10/2011

Driver: Modified driver start script to correct messages under Ubuntu.
Driver: Eliminated the global dev_check_id() routine.
Driver: Changed data type for dev_data_t.sem.
Driver: Updated the ADADIO_IOCTL_AIN_BUF_CLEAR service.
Driver: Fixed a bug in the GSC_INTCSR_MAILBOX_INT_ACTIVE macro.
Driver: Removed compiler warnings under Fedora 15.
Driver: Added macros for D0 through D31.
Driver: Modified gsc_sem_t to prevent hanging on an uninitialized structure.
Driver: Moved dev_check_id() functionality to dev_device_create().
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.
id: Corrected output spelling.
id: Updated the register output data.
sbtest: Removed compile warnings under Fedora 15.
sbtest: Corrected bugs that appeared under 64-bit Fedora 15.
sbtest: Updated the ADADIO_IOCTL_DATA_FORMAT test.
sbtest: Updated the ADADIO_IOCTL_LOOPBACK_CHANNEL test.
testapp: Removed compile warnings under 64-bit Linux.
Modified makefiles to correct messages under Ubuntu.

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

Version 3.3.22.0, Released 3/21/2011

Driver: Numerous updates per changes to the common code base. See main.h.
Driver: Updated the set of IOCTL services.
Driver: Implemented support for the common PIO I/O routines.
Driver: Improved INIT and AUTOCAL IOCTL services.
Updated numerous sources per changes in the set of supported IOCTL services.
Updated various Auto Cal related strings and macros for consistency.

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

Version 3.2.13.0, Released 12/28/2009

Driver: Modified open/close services to use GSC common code.
Driver: Updated GSC common code.
Driver: Removed color coding logic from driver start script.

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

Version 3.1.9.0, Released 7/29/2009

Driver: Fixed detection logic for device's DMDMA support.
Driver: Modified I/O services to use common argument types.
Driver: Added dev_check_id() service.
id: Corrected firmware version number decoding logic.

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

Version 3.0.5.0, Released 4/17/2009

Fixed a DMA bug: the first DMA returned incorrect data. This was previously and
	incorrectly reported here as a version 3.0.4.0 mod.
Modified some PLX register names for consistency.

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

Version 3.0.4.0, Released 4/10/2009

This was a complete overhaul of the driver.
The interface has changed; some services were added and some were removed.

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

Version 2.0

Full port to version 2.6 of the kernel.
Changed interface format to be similar to other Linux drivers.
Added user manual.

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