# ADDI-DATA APCI-1710 APCIe-1711 Linux Driver

**Copyright 2007 - ADDI-DATA**

See the main [README.md](../../../README.md) for general information about:
- User rights management for driver usage
- Driver build and installation process
- Troubleshooting (udev, kernel bumps, permission errors, Comedi conflicts)
- Loading drivers automatically at boot time

## API and Kernel Interface

### Header Files

See the ADDI-DATA header files in `include/linux/addidata/`:
- See `apci1710.h` for description of the IOCTL commands provided
- See `apci1710-kapi.h` for description of the kernel functions provided

## Device Files

For each board detected, the driver dynamically creates a special character device file:

- **Kernel 2.4**: File created in `/proc/sys/apci1710`
  - Major device number: provided by the operating system
  - Minor device number: ordinal in the PCI device list (order of detection)
  - File name: PCI slot identification (BUS/SLOT/FUNCTION in hexadecimal)

- **Kernel >= 2.6**: Node created under `/dev/apci1710`

**NOTE:** While your card might be an APCIE-1711, the device name under `/dev/` will still be `apci1710`. The driver support both cards.

## Function Modules

### set171x Software

Set171x software is provided with your 171X cards and is used to customize and deploy function modules, as well as to change the Master Version on 1711 cards.
For further information concerning function modules, please refer to the README for your card (1710, 1711).

### Supported Function Modules

| Module / Function          | Win 1710 HEX | Win 1711 HEX | Linux HEX | ID | Comment                                      |
|---------------------------:|:------------:|:------------:|:---------:|:--:|----------------------------------------------|
| Incremental Counter        | 5343         | 5343         | 5343      | SC | Both 1710 / 1711 and both OS                 |
| SSI Counter                | 5349         | 5349         | 5349      | SI | Both 1710 / 1711 and both OS                 |
| TTL IO                     | 544C         | 544C         | 544C      | TL | Both 1710 / 1711 and both OS                 |
| Digital IO                 | 4449         | 4449         | 4449      | DI | Both 1710 / 1711 and both OS                 |
| 82X54 Timer                | 4943         | 4943         | 4943      | IC | Both 1710 / 1711 and both OS                 |
| PWM                        | 5057         | 5057         | 5057      | PW | Both 1710 / 1711 and both OS                 |
| ETM                        | 4554         | 4554         | 4554      | ET | Both 1710 / 1711 and both OS                 |
| Chronometer                | 4348         | —            | 4348      | CH | 1710 FM                                      |
| Pulse Encoder              | 495A         | —            | 495A      | IZ | 1710 FM                                      |
| TOR Counter                | 544F         | —            | 544F      | TO | 1710 FM                                      |
| CDA                        | 4344         | —            | 4344      | CD | 1710 FM                                      |
| BiSS Master                | —            | 424D         | 424D      | BM | 1711 FM                                      |
| EnDat                      | —            | 454E         | 454E      | EN | 1711 FM                                      |
| Parallel Interface         | —            | 5049         | —         | PI | 1711 FM // Windows only                      |
| SinCos                     | —            | 534E         | —         | SN | 1711 FM // Windows only                      |
| Tamagawa                   | —            | 5457         | —         | TW | 1711 FM // Windows only                      |
| SpeedBox                   | —            | —            | 5342      | SB | Deprecated / Not used / old version of IC    |
| Ballistic                  | 4241         | —            | 4241      | BA | OldDriver DLL FM                             |
| PTP                        | —            | —            | 5054      | PT | Deprecated / Not used / old version of PWM   |

### Missing or need a new Function Module?

In that case, please contact Addi Data via email: <info@addi-data.com>.
We will assess the possibility of adding or updating the corresponding function module.

For any request or remark please contact us:
<info@addi-data.com>
