Documentation patchset
Subsystems (3)
cover Documentation patchset
Add some useful documentation for the ISDN subsystem. Orignal patches are from Tilman Schmidt.
I fixed some whitespace issues and added the URL for the CAPI 2.0 spec.
Karsten Keil (1):
Add reference to CAPI 2.0 standard
Tilman Schmidt (2):
update Documentation/isdn/00-INDEX
Documentation/isdn/INTERFACE.CAPI
Documentation/isdn/00-INDEX | 17 +++- Documentation/isdn/INTERFACE.CAPI | 208 +++++++++++++++++++++++++++++++++++++ drivers/isdn/capi/kcapi.c | 171 ++++++++++++++++++++++++++++++ 3 files changed, 392 insertions(+), 4 deletions(-) create mode 100644 Documentation/isdn/INTERFACE.CAPI
PATCH 2/3 Documentation/isdn/INTERFACE.CAPI
Date: Tue, 21 Apr 2009 11:18:52 +0200
isdn: document Kernel CAPI driver interface
Create a file Documentation/isdn/INTERFACE.CAPI describing the interface between the kernel CAPI subsystem and ISDN device drivers, analogous to the existing Documentation/isdn/INTERFACE for the old isdn4linux subsystem. Also add kerneldoc comments to the exported functions in drivers/isdn/capi/kcapi.c.
Impact: Documentation
--- Documentation/isdn/00-INDEX | 2 + Documentation/isdn/INTERFACE.CAPI | 207 +++++++++++++++++++++++++++++++++++++ drivers/isdn/capi/kcapi.c | 171 ++++++++++++++++++++++++++++++ 3 files changed, 380 insertions(+), 0 deletions(-) create mode 100644 Documentation/isdn/INTERFACE.CAPI
Documentation/isdn/00-INDEX +2 -0
@@ -8,6 +8,8 @@ INTERFACE - description of isdn4linux Link Level and Hardware Level interfaces. INTERFACE.fax - description of the fax subinterface of isdn4linux. +INTERFACE.CAPI + - description of kernel CAPI Link Level to Hardware Level interface. README - general info on what you need and what to do for Linux ISDN. README.FAQ
Documentation/isdn/INTERFACE.CAPI new file +207 -0
207 lines not on this page · raw message
drivers/isdn/capi/kcapi.c +171 -0
285 lines not on this page · raw message
Signature · 1 line
1.6.0.2
PATCH 3/3 Add reference to CAPI 2.0 standard
In reply to Karsten KeilMove the entry about CAPI 2.0 to the beginning and add a URL. Incorporate changes suggested by Randy Dunlap, thanks for proofreading.
--- Documentation/isdn/INTERFACE.CAPI | 20 +++++++++++++------- 1 files changed, 13 insertions(+), 7 deletions(-)
Documentation/isdn/INTERFACE.CAPI +13 -7
@@ -3,6 +3,11 @@ Kernel CAPI Interface to Hardware Drivers 1. Overview +From the CAPI 2.0 spezification: +COMMON-ISDN-API (CAPI) is an application programming interface standard used +to access ISDN equipment connected to basic rate interfaces (BRI) and primary +rate interfaces (PRI). + Kernel CAPI operates as a dispatching layer between CAPI applications and CAPI hardware drivers. Hardware drivers register ISDN devices (controllers, in CAPI lingo) with Kernel CAPI to indicate their readiness to provide their service
@@ -12,6 +17,9 @@ application registration to an available device, forwarding it to the corresponding hardware driver. Kernel CAPI then forwards CAPI messages in both directions between the application and the hardware driver. +Format and semantics of CAPI messages are specified in the CAPI 2.0 standard. +This standard is freely available from http://www.capi.org. + 2. Driver and Device Registration
@@ -53,12 +61,10 @@ open() operation on regular files or character devices. After a successful return from register_appl(), CAPI messages from the application may be passed to the driver for the device via calls to the send_message() callback function. The CAPI message to send is stored in the -data portion of a skb. Conversely, the driver may call Kernel CAPI's +data portion of an skb. Conversely, the driver may call Kernel CAPI's capi_ctr_handle_message() function to pass a received CAPI message to Kernel CAPI for forwarding to an application, specifying its ApplID. -Format and semantics of CAPI messages are specified in the CAPI 2.0 standard. - Deregistration requests (CAPI operation CAPI_RELEASE) from applications are forwarded as calls to the release_appl() callback function, passing the same ApplID as with register_appl(). After return from release_appl(), no CAPI
@@ -75,9 +81,9 @@ the following non-private fields, all to be set by the driver before calling register_capi_driver(): char name[32] - the name of the driver, as a zero terminated ASCII string + the name of the driver, as a zero-terminated ASCII string char revision[32] - the revision number of the driver, as a zero terminated ASCII string + the revision number of the driver, as a zero-terminated ASCII string int (*add_card)(struct capi_driver *driver, capicardparams *data) a callback function pointer (may be NULL)
@@ -100,10 +106,10 @@ void *driverdata an opaque pointer to driver specific data, not touched by Kernel CAPI char name[32] - the name of the controller, as a zero terminated ASCII string + the name of the controller, as a zero-terminated ASCII string char *driver_name - the name of the driver, as a zero terminated ASCII string + the name of the driver, as a zero-terminated ASCII string int (*load_firmware)(struct capi_ctr *ctrlr, capiloaddata *ldata) (optional) pointer to a callback function for sending firmware and
Signature · 1 line
1.6.0.2
PATCH 1/3 update Documentation/isdn/00-INDEX
In reply to Karsten KeilDate: Tue, 7 Apr 2009 17:51:32 +0200
After the merging of mISDN, state which files refer only to the old isdn4linux subsystem. Also add a few missing files.
--- Documentation/isdn/00-INDEX | 15 +++++++++++---- 1 files changed, 11 insertions(+), 4 deletions(-)
Documentation/isdn/00-INDEX +11 -4
@@ -2,8 +2,12 @@ - this file (info on ISDN implementation for Linux) CREDITS - list of the kind folks that brought you this stuff. +HiSax.cert + - information about the ITU approval certification of the HiSax driver. INTERFACE - - description of Linklevel and Hardwarelevel ISDN interface. + - description of isdn4linux Link Level and Hardware Level interfaces. +INTERFACE.fax + - description of the fax subinterface of isdn4linux. README - general info on what you need and what to do for Linux ISDN. README.FAQ
@@ -12,6 +16,8 @@ README.audio - info for running audio over ISDN. README.fax - info for using Fax over ISDN. +README.gigaset + - info on the drivers for Siemens Gigaset ISDN adapters. README.icn - info on the ICN-ISDN-card and its driver. README.HiSax
@@ -37,7 +43,8 @@ README.diversion README.sc - info on driver for Spellcaster cards. README.x25 - _ info for running X.25 over ISDN. + - info for running X.25 over ISDN. README.hysdn - - info on driver for Hypercope active HYSDN cards - + - info on driver for Hypercope active HYSDN cards +README.mISDN + - info on the Modular ISDN subsystem (mISDN).
Signature · 1 line
1.6.0.2
Re: [PATCH 3/3] Add reference to CAPI 2.0 standard
In reply to Karsten KeilQuoted 13 lines · On Wed, 22 Apr 2009 16:31:48 +0200 Karsten Keil wrote:
Move the entry about CAPI 2.0 to the beginning and add a URL. Incorporate changes suggested by Randy Dunlap, thanks for proofreading.
Signed-off-by Karsten Keil <[email protected]>--- Documentation/isdn/INTERFACE.CAPI | 20 +++++++++++++------- 1 files changed, 13 insertions(+), 7 deletions(-)Documentation/isdn/INTERFACE.CAPI +0
-0
Documentation/isdn/INTERFACE.CAPI Kernel CAPI Interface to Hardware Drivers · line 6
Quoted 4 lines
Documentation/isdn/INTERFACE.CAPI +1
-0@@ -3,6 +3,11 @@ Kernel CAPI Interface to Hardware Drivers 1. Overview +From the CAPI 2.0 spezification:
~~~~~~~~~~~~~
typo or language? specification:
Quoted 47 lines
Documentation/isdn/INTERFACE.CAPI +10
-5+COMMON-ISDN-API (CAPI) is an application programming interface standard used +to access ISDN equipment connected to basic rate interfaces (BRI) and primary +rate interfaces (PRI). + Kernel CAPI operates as a dispatching layer between CAPI applications and CAPI hardware drivers. Hardware drivers register ISDN devices (controllers, in CAPI lingo) with Kernel CAPI to indicate their readiness to provide their service@@ -12,6 +17,9 @@ application registration to an available device, forwarding it to the corresponding hardware driver. Kernel CAPI then forwards CAPI messages in both directions between the application and the hardware driver. +Format and semantics of CAPI messages are specified in the CAPI 2.0 standard. +This standard is freely available from http://www.capi.org. + 2. Driver and Device Registration@@ -53,12 +61,10 @@ open() operation on regular files or character devices. After a successful return from register_appl(), CAPI messages from the application may be passed to the driver for the device via calls to the send_message() callback function. The CAPI message to send is stored in the -data portion of a skb. Conversely, the driver may call Kernel CAPI's +data portion of an skb. Conversely, the driver may call Kernel CAPI's capi_ctr_handle_message() function to pass a received CAPI message to Kernel CAPI for forwarding to an application, specifying its ApplID. -Format and semantics of CAPI messages are specified in the CAPI 2.0 standard. - Deregistration requests (CAPI operation CAPI_RELEASE) from applications are forwarded as calls to the release_appl() callback function, passing the same ApplID as with register_appl(). After return from release_appl(), no CAPI@@ -75,9 +81,9 @@ the following non-private fields, all to be set by the driver before calling register_capi_driver(): char name[32] - the name of the driver, as a zero terminated ASCII string + the name of the driver, as a zero-terminated ASCII string char revision[32] - the revision number of the driver, as a zero terminated ASCII string + the revision number of the driver, as a zero-terminated ASCII string int (*add_card)(struct capi_driver *driver, capicardparams *data) a callback function pointer (may be NULL)@@ -100,10 +106,10 @@ void *driverdata an opaque pointer to driver specific data, not touched by Kernel CAPI
Documentation/isdn/INTERFACE.CAPI void *driverdata · line 115
Quoted 10 lines
Documentation/isdn/INTERFACE.CAPI +2
-2char name[32] - the name of the controller, as a zero terminated ASCII string + the name of the controller, as a zero-terminated ASCII string char *driver_name - the name of the driver, as a zero terminated ASCII string + the name of the driver, as a zero-terminated ASCII string int (*load_firmware)(struct capi_ctr *ctrlr, capiloaddata *ldata) (optional) pointer to a callback function for sending firmware and
---
~Randy
Quoted 3 lines · On Wed, 22 Apr 2009 16:31:48 +0200 Karsten Keil wrote:
Add some useful documentation for the ISDN subsystem. Orignal patches are from Tilman Schmidt.
I fixed some whitespace issues and added the URL for the CAPI 2.0 spec.
Looks good. Thanks.
Quoted 7 lines
Karsten Keil (1):
Add reference to CAPI 2.0 standardTilman Schmidt (2):
updateDocumentation/isdn/00-INDEX
Documentation/isdn/INTERFACE.CAPI
Quoted 5 lines
Documentation/isdn/00-INDEX | 17 +++- Documentation/isdn/INTERFACE.CAPI | 208 +++++++++++++++++++++++++++++++++++++ drivers/isdn/capi/kcapi.c | 171 ++++++++++++++++++++++++++++++ 3 files changed, 392 insertions(+), 4 deletions(-) create mode 100644 Documentation/isdn/INTERFACE.CAPI
---
~Randy
Re: [PATCH 3/3] Add reference to CAPI 2.0 standard
In reply to Randy DunlapQuoted 15 lines · On Donnerstag, 23. April 2009 02:32:32 Randy Dunlap wrote:
Quoted 14 lines · On Wed, 22 Apr 2009 16:31:48 +0200 Karsten Keil wrote:
Move the entry about CAPI 2.0 to the beginning and add a URL. Incorporate changes suggested by Randy Dunlap, thanks for proofreading.
Signed-off-by Karsten Keil <[email protected]>--- Documentation/isdn/INTERFACE.CAPI | 20 +++++++++++++------- 1 files changed, 13 insertions(+), 7 deletions(-)(quoted diff) +0
-0b/Documentation/isdn/INTERFACE.CAPI index 8947ffc..4d802ee 100644
Documentation/isdn/INTERFACE.CAPI +0
-0@@ -3,6 +3,11 @@ Kernel CAPI Interface to Hardware Drivers
Quoted 7 lines
Documentation/isdn/INTERFACE.CAPI Kernel CAPI Interface to Hardware Drivers · line 6
Quoted 3 lines
Documentation/isdn/INTERFACE.CAPI +1
-01. Overview +From the CAPI 2.0 spezification:~~~~~~~~~~~~~typo or language? specification:
Ouch :-(, never add a single line without spell checking.
Will send out a new set, also fix the wrong From: line in the patches from Tilman.
...