Skip to content
BranchesTags

Repository files navigation

ASIX AX99100A PCIe to Serial/UART/Parallel/SPI Linux driver (ax99100x.ko)

This is the official ASIX AX99100A PCIe to Serial/UART/Parallel/SPI Linux driver source (module name: ax99100x.ko), which is suitable for various I/O interface connectivity applications such as PCIe serial/parallel cards, PCIe data acquisition (DAQ) cards, industrial computers, industrial automation equipment, measurement instrumentation equipment, medical devices, POS terminals and industrial embedded systems.

ASIX PCIe to Serial/UART/Parallel/SPI/GPIO I/O bridge ICs

Supported PCIe to Multi-I/O (4S, 2S+1P, 2S+SPI, LB) modes

  • 4S : PCIe to 4 serial/UART ports
  • 2S+1P : PCIe to 2 serial/UART ports + 1 parallel port
  • 2S+SPI : PCIe to 2 serial/UART ports + 1 SPI interface
  • LB : PCIe to Localbus/SRAM-like interface

Supported PCIe to Serial/UART/Parallel/SPI Interfaces

IC PCIe VEN:DEV ID Sub VEN:DEV ID Interfaces
AX99100A, AX99100 125B:9100 1000:A000 PCIe to Serial/UART Ports
AX99100A, AX99100 125B:9100 2000:A000 PCIe to Parallel Ports
AX99100A, AX99100 125B:9100 6000:A000 PCIe to SPI Interfaces

Driver and test tool Guide

Method1: Building deb file for installation: Building the Driver and application:

Run the following command in the driver source folder:
	$ make deb

Once the driver is compiled, the install package ax99100x-drv_x.x.x_all.deb will be created in the same folder.

**  '$' --this symbol represents the shell prompt on linux

installing the Driver:

To install the driver use the following command:
	$ sudo dpkg -i ax99100x-drv_x.x.x_all.deb

Method2: Manual compile and install drivers Building the Driver and application:

Run the following command in the driver source folder:
	$ make

Once the driver is compiled, the loadable module ax99100x.ko will be created in the same folder.

Loading the Driver:

To load the driver use the following command:
	$ insmod ax99100x.ko

Unloading the Driver:

To unload the driver use the following command:
	$ rmmod ax99100x

Installing the Serial & Parallel Port Driver:

To install the driver use the following command:
	
	make install

Uninstalling the Serial & Parallel Port Driver:

To un-install the driver use the following command:
	
	make uninstall

Features Supported:

The driver supports all the features supported by the AX99100x serial device and the AX99100x SPI device.
	Note: baud rates upto 25.0Mbps are implemented in the current driver.

Feature Configuration:

AX99100x serial port:

This driver comes with a static array uart_99100_contxts[ ] for all the 16 ports features in the ax99100_sp.h & ax99100_sp.c file.
Where you can set the features like:
	-DMA in RX
	-DMA in TX
	-enable/disable Flow control
	-Flow control type
	-RX fifo trigger level
	-TX fifo trigger level
	-x-on character
	-x-off character
	-MSI/Lagecy interrupt selections
	-Functions selections SPI+SP/SP only


selects Interrupt type as below comment.
#define INT_TYPE 0	// 0: using legacy interrupt	
					// 1: using msi interrupt

selects Functions as below comment.
#define FUNC_SELECT 0	// 0: Serial Port only
						// 1: Serial Port+SPI


An example array setting for PORT 0 which will be recognised as /dev/ttyF0:			

//Port 0	--**This represents that this setting is for port 0 which will be recognised as /dev/ttyF0
{
	.rx_dma_en	= 0,
	.tx_dma_en	= 0,
	.uart_mode	= AX99100_RS232_MODE,
	.en_flow_control= 0,
	.flow_ctrl_type = AX99100_XON_XOFF_HW_FLOWCONTROL,
	.rxfifotrigger	= 64,
	.txfifotrigger	= 64,		
	.x_on		= SERIAL_DEF_XON,
	.x_off		= SERIAL_DEF_XOFF,
},

To change the port to different modes for uart_mode settings use the following,

AX99100_RS422_MODE           	(422 mode)
AX99100_RS485_HALF_DUPLEX    	(485 half duplex)
AX99100_RS485_HALF_DUPLEX_ECHO	(485 half duplex echo)
AX99100_RS485_FULL_DUPLEX    	(485 full duplex)
AX99100_RS485_FULL_DUPLEX_TXEN	(485 full duplex DxEN)
	
If you are use AX99100 chip with multi-protocol mode, the uart_99100_contxts[ ] array features need to setup.

{
	...
	.ltc2872_te485 	= 0,
	.ltc2872_dz 	= 0,
	.ltc2872_lb 	= 0,
	.ltc2872_fen 	= 0,
	.pci_config_l0s	= 0,
	.pci_config_l1 	= 0,
}

Kernels:

This driver is currently developed and tested on v2.6.13 linux kernel and above to v6.8

Limitations:

This ax99100 driver supports a maximum of 4 serial devices or spi device. This can be modified as required

Step of loading parallel port:

method 1(default): 1. rmmod lp 2. rmmod parport_pc 3. insmod parport_pc.ko 4. modprobe lp

method 2(commonly for ARM platform): 1. Select the PARPORT_PCI_BASE & PARPORT_IRQ_ENABLE in ax99100x_pp.c ex: #define PARPORT_PCI_BASE 1 //0:iobase 1:membase #define PARPORT_IRQ_ENABLE 0 //0:IRQ Disable 1:IRQ Enable #define PARPORT_COMPAT 0 //0:No Compatibility adjustment 1:Compatibility adjustment Enable 2. compiled driver. 3. insmod ax99100_pp.ko

Steps for setting gpio[7:0] :

Execute the "gpio_99100" application and the application will show:
		
	Please input the port of AX99100. (ex. /dev/ttyF0):

After specify the serial port, application will show these selections to access GPIO: 
	0  : GPIO status
	1  : Setup GPIO direction
	2  : GPIO write
	99 : Exit

Steps for setting SPI driver:

SPI driver: 1. modified the FUNC_SELECT to 1 inside ax99100_sp.h as below. ex: #define FUNC_SELECT 1 // 0: Serial Port only // 1: Serial Port+SPI 2. recompiled & insmod AX99100x.ko

SPI standard controller driver: 1. modified the FUNC_SELECT to 0 inside ax99100_sp.h as below. ex: #define FUNC_SELECT 0 // 0: Serial Port only // 1: Serial Port+SPI

	2. compiled the standard SPI controller driver in the folder "Standard_SPI_Controller_Driver"
	3. insmod spi-ax99100.ko

SPI Test Tool Flow:

**This tool only supports with "ax99100x_spi" driver, doesn't support with Standard_SPI_Controller_Driver.**
	needs to modified FUNC_SELECT to 1 inside ax99100_sp.h as below before compiling driver.
ex:	#define FUNC_SELECT 1	// 0: Serial Port only
							// 1: Serial Port+SPI

**This spi_test tool is used for the AX99100 SPI Demo Board non decoder.**

The test case according to the following steps:

#Open AX99100 SPI device:
	Open char device with AX99100 SPI(ex./dev/spi0)
$./spi_test /dev/spi0

#Step 1:
	Set the SPI Control Master Register. Input 457 to set SPIMEN, ASS and SSOE bit.

/-----------------------------------------------------------------/
SPICMR Setting

Number: 0	1	2	3	4	5	6	7		
Name:   SSP	CPHA	CPOL	LSB	SPIMEN	ASS	SWE	SSOE	

Example: Need to set SPIMEN ASS SSOE bits, and the value is 457
Input the value of SPICMR: 457
/-----------------------------------------------------------------/


#Step 2:
	Select SPI Source Clocks. Input 0 to select the source clock, 125MHz.

/-----------------------------------------------------------------/
SPICSS SPICKS Setting

Valus:	0:125MHz
	1:100MHz
	2,3:EXT_CLK
Input the value of SPICKS: 0
/-----------------------------------------------------------------/


#Step 3:
	Select whether to enable the clock divide. Input 1 to enable the clock divider.

/-----------------------------------------------------------------/
SPICSS SPIDIVEN Setting

Valus:	0:Disable
	1:Enable
Input the value of SPIDIVEN: 1
/-----------------------------------------------------------------/


#Step 4:
	Set the SPI Divider. Input 3 to set the SPI Divider.

/-----------------------------------------------------------------/
SPIDIVIDER Setting

Valus:	0 - 255
Input the value of SPIDIVIDER: 3
/-----------------------------------------------------------------/


#Step 5:
	Select whether to enable the external decoder. Input 0 to disable the externel decoder.

/-----------------------------------------------------------------/
Externel Decoder Setting

Valus:	0:Disable
	1:Enable
Input the value of EDE: 0
/-----------------------------------------------------------------/


#Step 6:
	Select the desired slave device. Input 0 to select Device 0.

/-----------------------------------------------------------------/
Divice Setting

Valus:	0 - 2 (Device 0 - Device 2)
Input the value of device: 0
/-----------------------------------------------------------------/


#Step 7:
	Set the test count. Input 10 to perform ten times for test.

/-----------------------------------------------------------------/
Data Test Count Setting

Input the value of test count: 10
/-----------------------------------------------------------------/


#Step 8:
	Select Tx, Rx or TXRX(Compare). Input 2 to select TX & RX (Compare data).

/-----------------------------------------------------------------/
Data Tx/Rx Direction Setting

Valus:	0:TX
	1:RX
	2:TX & RX
Input the value of direction: 2
/-----------------------------------------------------------------/


#Step 9:
	Set the data pattern type. Input 255 to set the data pattern type. (255 -> 0xff)

/-----------------------------------------------------------------/
Data Pattern Type Setting

Valus:	0 - 255 (0x00 - 0xff)
Input the value of pattern: 255
/-----------------------------------------------------------------/


#Step 10:
	Select Interrupt or Polling. Input 1 to select the Polling mode.

/-----------------------------------------------------------------/
Data Interrupt Setting

Method:	0:Interrupt
	1:Polling
Select the mode: 1
/-----------------------------------------------------------------/


#Step 11:
	If you want to modify one data setting, select the data item.
	Run test to select number 9.

/-----------------------------------------------------------------/
*************************************************
*               Test SPI Setting                *
*************************************************
**Initial Information:
SPICMR: 0xb0 ( SPIMEN ASS SSOE )
SPICKS: 0x00 ( 125MHz )		SPIDIVEN: 0x1 ( Enable )	SPIDIVIDER: 3

**Test Setting:
Test Direction: TX & RX
Device Num.:  0x6	Test Count:     10	Externel Decoder: 0x0 ( Disable )
Pattern Type: 0xff	Data Length:   256	Interrupt Mode:   Polling

***Initial data***
 0: Modify SPICMR
 1: Modify SPICKS
 2: Modify SPIDIVIDER
***Test setting***
 3: Select Device
 4: Modify Data Pattern(for tx)
 5: Modify Test Count
 6: Select Tx or Rx
 7: Modify Data Length
 8: Select Interrupt Mode

 9: Test performace.
99: Exit the test tool.
Please choose: 9
/-----------------------------------------------------------------/


#Result:
	If you want to run test with the same setting, input Y or y.
	Otherwise, input N or n.
	
/-----------------------------------------------------------------/
*************************************************
*               Test SPI Setting                *
*************************************************
**Initial Information:
SPICMR: 0xb0 ( SPIMEN ASS SSOE )
SPICKS: 0x00 ( 125MHz )		SPIDIVEN: 0x1 ( Enable )	SPIDIVIDER: 3

**Test Setting:
Test Direction: TX & RX
Device Num.:  0x6	Test Count:     10	Externel Decoder: 0x0 ( Disable )
Pattern Type: 0xff	Data Length:   256	Interrupt Mode:   Polling
*************************************************
*                 Throughput                    *
*************************************************
Test Counter: 10
TX Throughput: 0.385650 MB/s
RX Throughput: 4.569484 MB/s

Test again?(Y/N):n	
/-----------------------------------------------------------------/

Serial Port 9-bit mode test flow:

Execute the "9bit_test" application and the application will show:

Usage:9bit_test [dev] [option] Example: (9-bit mode: Master, ID: 20) ./9bit_test /dev/ttyF0 -m 1 -i 20 -m [Mode] 1:Master 2:Slave SW 3:Slave HW 4:Data mode -i [Address ID] range 0-255

Future Plan & Goals

  1. Stabilize current integrated driver
  2. Separate functionality into individual modules
  3. Code cleanup and documentation
  4. Submit drivers to mainline kernel

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues for discussion.

License

SPDX-License-Identifier: GPL-2.0-only

About

Official ASIX AX99100A PCIe to Serial/UART/Parallel/SPI Linux driver source

www.asix.com.tw/en/product/Interface/PCIe_Bridge/AX99100A

Topics

asixax99100agpiokernel-modulelinux-driverlocalbusparallelpcieserialspiuart

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages