; $URL: http://subversion:8080/svn/gsc/trunk/drivers/LINUX/OPTO32/OPTO32_Linux_7.x.x.x_GSC_DN/doc/release.txt $
; $Rev: 22607 $
; $Date: 2013-07-16 12:34:28 -0500 (Tue, 16 Jul 2013) $

OPTO32: Linux Driver Release Notes

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

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

Version 8.8.111.50.0, Released 7/23/2024

driver: Updated for Fedora 38.
driver: Updated the make file for consistency.
driver: Updated the driver start script.
driver: Corrected error message text.
driver: Added support for HPDI32-COS model boards.
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: Corrected a comment.
driver: LINTed the sources for the 2.4 kernel builds.
driver: LINTed sources.
driver: Updated to address Fedora 38 complaints.

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

Version 8.7.104.47.0, Released 6/20/2023

driver: Updated to support the 6.x series kernel.
driver: Updated comments for consistency.
driver: Added RX DEBUG capabilities.
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.

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

Version 8.6.101.43.0, Released 10/7/2022

driver: Updated some comments for consistency.
driver: Updated for changes to Red Hat Enterprise Linux 8.6.

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

Version 8.5.100.41.0, Released 10/7/2022

driver: Removed unintended debug output statements.

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

Version 8.5.99.41.0, Released 6/30/2022

driver: Modified for use under Windows.
driver: Removed DMA code as the driver doesn't use DMA.
driver: Removed unused macros.
driver: White space cleanup.
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 debugging display output.
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: Began implementing MSI support.
driver: Added macro DEV_IRQ_SHOW to report assigned IRQ assigned to device.
driver: Updated for the 5.14 kernel.
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.

SDK dropped from release.

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

Version 8.4.93.36.0, Released 3/25/2021

driver: Corrected endian error message.
driver: Fixed a timeout bug in gsc_write_pio_work_32_bit().
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.

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

Version 8.4.93.36.0, Released 5/22/2020

driver: Modified for use under Windows.
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: 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 accommodatedate porting to another OS.

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

Version 8.3.87.28.1, Released 8/9/2019

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

Version 8.3.87.28.0, Released 7/17/2019

driver: Updated initial file content for consistency.
driver: Added support for the 5.x kernel series.
driver: Added Endianness support.
driver: Added support for Big Endian hosts.
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: Updated initialization for the write service.
driver: Updated muti-channel ISR code for new I/O streams structure.
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: Fixed 9060 Endian support bug.
driver: Added error reporting when IRQ cound not be acquired during open requests.
driver: Some minor code reorganization.
driver: Updated BAR creation logic.

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

Version 8.2.80.26.0, Released 9/6/2018

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: Corrected bug in US and MS debounce IOCTL services.
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 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: 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 8.1.69.18.1, Released 6/13/2018

This release consistes only of a user manual with an updated inside code page.

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

Version 8.1.69.18.0, Released 12/16/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: 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: 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: 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.
driver: Removed the use of __DATE__ and __TIME__.

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

Version 8.0.60.8.0, Released 9/16/2015

driver: Updated to use the newer common driver sources.
driver: Removed LINT remarks from 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.
din: Renamed one or more variables.
dout: Renamed one or more variables.
led: Renamed one or more variables.
sdk/api: Updated to use the newer common Linux driver sources.
sdk/irq: Renamed one or more variables.
sdk/lb: Renamed one or more variables.
sdk/led: Renamed one or more variables.
sdk/rx: Renamed one or more variables.
sdk/tx: Renamed one or more variables.
LINTed all source files.
White space cleanup.

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

Version 7.7.52.0, Released 2/28/2014

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

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

Version 7.6.51.0, Released 1/9/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 7.6.48.0, Released 11/8/2013

Driver: Corrected an IOCTL table initialization value.
Driver: The IOCTL command code is now treated as an integer.
Driver: Additional LINTing of the sources.

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

Version 7.5.47.0, Released 9/10/2013

Driver: Linted the sources.
Driver: Fixed a bug in the OPTO32_IOCTL_DEBOUNCE_US service.
Driver: Numerous updates for Concurrent and for PEX8311 issues.
Ported the SDK API to this driver; including all sample apps and documentation.

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

Version 7.4.45.0, Released 7/16/2013

Driver: Freeing the board interrupt is now conditioned upon it being acquired.
Driver: Added support for the Bus Abort interrupt.
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_irq_destroy() - does cleanup when done.

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

Version 7.4.39.0, Released 12/21/2011

Driver: Updated for the 3.x kernel.
Driver: White space cleanup.
Driver: Added support for boards that need additional setup after a DMA channel has been selected.
Driver: Made the IOCTL buffer larger - 512 bytes.
Driver: Removed compile warnings from the copy_from_user_ret macro.
Updated makefiles for consistency.
Updated the utils interface for consistency.
Applications: Updated the parameter list to gsc_id_driver().

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

Version 7.3.34.0, Released 12/21/2011

Driver: BAR0 and BAR2 are now the only BAR regions used.
Driver: Include all common source, though not all are used.
Split the utility code into two libraries: common and device specific.

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

Version 7.2.32.0, Released 11/10/2011

Driver: Eliminated the global dev_check_id() routine.
Driver: Fixed a bug in the GSC_INTCSR_MAILBOX_INT_ACTIVE macro.
Driver: Removed a compiler warning under Fedora 15.
Driver: Added #defines 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().
id: Corrected output spelling.
id: Updated the register listing.

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

Version 7.1.25.0, Released 5/29/2011

Driver: Modified so BAR2 could be memory or I/O mapped.
Driver: Modified driver start script to correct messages under Ubuntu.
Driver: Added support for deprication of file_ops.ioctl.
Driver: Started PLX EEPROM access support.
Driver: Corrected the _1M macro.
Modified makefiles to correct messages under Ubuntu.

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

Version 7.0.22.0, Released 1/17/2011

Driver: This release is a replacement for the SDK release.

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

Version 1.1.17.0, Released 6/29/2010

Driver: The subsystem id search criteria has been changed to match the board.

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

Version 1.0-BETA.17.0, Released 6/24/2010

Initial release.
Driver: This version of the driver uses a temporary subsystem id value. Once a
	proper id value is obtained from PLX Technologies a non-beta release will be
	produced.

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