Skip to contentSkip to conversation

Documentation patchset

PATCH In review Karsten Keil 3 participants 11 messages Apr 23, 2009 – Apr 28, 2009

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v2 cover Documentation patchset

Fixed one more typo and wrong From: lines.

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 |  213 +++++++++++++++++++++++++++++++++++++
 drivers/isdn/capi/kcapi.c         |  171 +++++++++++++++++++++++++++++
 3 files changed, 397 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/isdn/INTERFACE.CAPI
#2 lore raw

PATCH v2 2/3 Documentation/isdn/INTERFACE.CAPI

From: Tilman Schmidt <[email protected]>
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
index d9660ee..5a2d699 100644
@@ -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
#3 lore raw

PATCH v2 3/3 Add reference to CAPI 2.0 standard

In reply to Karsten Keil

From: Karsten Keil <[email protected]>
Move 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
index 8947ffc..786d619 100644
@@ -3,6 +3,11 @@ Kernel CAPI Interface to Hardware Drivers
 
 1. Overview
 
+From the CAPI 2.0 specification:
+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
#1 lore raw

PATCH v2 1/3 update Documentation/isdn/00-INDEX

In reply to Karsten Keil

From: Tilman Schmidt <[email protected]>
Date: 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
index 9fee5f2..d9660ee 100644
@@ -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
maintainer
#4 lore raw
In reply to Karsten Keil

From: Karsten Keil <[email protected]>
Date: Thu, 23 Apr 2009 14:24:21 +0200

Quoted 5 lines

Fixed one more typo and wrong From: lines.

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.

This patch set does not apply at all to net-2.6

#5 lore raw
Quoted 10 lines · On Montag, 27. April 2009 12:13:23 David Miller wrote:

From: Karsten Keil <[email protected]>
Date: Thu, 23 Apr 2009 14:24:21 +0200

Quoted 5 lines

Fixed one more typo and wrong From: lines.

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.

This patch set does not apply at all to net-2.6

Hmm I did it against a clean Linus tree, so I assume a part from some earlier patch is already in net-2.6, I will redo the patch against net-2.6 and send it to netdev only.

Karsten

#6 lore raw
In reply to David Miller

Hi David,

Quoted 10 lines · On Montag, 27. April 2009 12:13:23 David Miller wrote:

From: Karsten Keil <[email protected]>
Date: Thu, 23 Apr 2009 14:24:21 +0200

Quoted 5 lines

Fixed one more typo and wrong From: lines.

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.

This patch set does not apply at all to net-2.6

I do not understand this, the patches were created against Linus tree, but now I checked out the net-2.6 tree and tried to apply them and it was successful, no warnings, and indeed the affected files in Linus tree and in net-2.6 are the same versions. To be sure that no MTA problem hit us, I used the mails which were sent back from the list.
net-2.6 git tree was updated 15 minutes ago.

Here what I did:

kkeil@pingi:/w_pingi/git/net-2.6> git status
# On branch master
nothing to commit (working directory clean) kkeil@pingi:/w_pingi/git/net-2.6> git describe v2.6.29-10830-g1c41e23
kkeil@pingi:/w_pingi/git/net-2.6> git am /tmp/\[PATCH\ v2\ 1_3\]\ update\
Documentation_isdn_00-INDEX.mbox
Applying: update Documentation/isdn/00-INDEX kkeil@pingi:/w_pingi/git/net-2.6> git am /tmp/\[PATCH\ v2\ 2_3\]\
Documentation_isdn_INTERFACE.mbox
Applying: Documentation/isdn/INTERFACE.CAPI kkeil@pingi:/w_pingi/git/net-2.6> git am /tmp/\[PATCH\ v2\ 3_3\]\ Add\
reference\ to\ CAPI\ 2.mbox
Applying: Add reference to CAPI 2.0 standard

Karsten

#10 lore raw
In reply to David Miller
Quoted 10 lines · David Miller

From: Karsten Keil <[email protected]>
Date: Thu, 23 Apr 2009 14:24:21 +0200

Quoted 5 lines

Fixed one more typo and wrong From: lines.

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.

This patch set does not apply at all to net-2.6

Strange. It applies fine to the linux-2.6 I pulled this morning.

Signature · 4 lines
Tilman Schmidt                    E-Mail: [email protected]
Bonn, Germany
Diese Nachricht besteht zu 100% aus wiederverwerteten Bits.
Ungeöffnet mindestens haltbar bis: (siehe Rückseite)
maintainer
#7 lore raw
In reply to Karsten Keil

From: Karsten Keil <[email protected]>
Date: Mon, 27 Apr 2009 13:45:34 +0200

Quoted 14 lines

Hi David,

Quoted 10 lines · On Montag, 27. April 2009 12:13:23 David Miller wrote:

From: Karsten Keil <[email protected]>
Date: Thu, 23 Apr 2009 14:24:21 +0200

Quoted 5 lines

Fixed one more typo and wrong From: lines.

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.

This patch set does not apply at all to net-2.6

Quoted 8 lines

I do not understand this, the patches were created against Linus tree, but now I checked out the net-2.6 tree and tried to apply them and it was successful, no warnings, and indeed the affected files in Linus tree and in net-2.6 are the same versions. To be sure that no MTA problem hit us, I used the mails which were sent back from the list.
net-2.6 git tree was updated 15 minutes ago.

Here what I did:

Here they are in patchwork, they don't apply:

http://patchwork.ozlabs.org/patch/26362/
http://patchwork.ozlabs.org/patch/26363/
http://patchwork.ozlabs.org/patch/26361/

Oh I see what happened.

IT'S THOSE STUPID "Date:" fields you added to the body of 2 of those patches. It caused patchwork to put them in the wrong order when I put them together into a bundle.

Don't add extra email header fields like that, please! :-)

I fixed it up and applied the patches.

#8 lore raw

On Monday, 27. April 2009 14:39:02 you wrote:
...

Quoted 9 lines

Here they are in patchwork, they don't apply:

http://patchwork.ozlabs.org/patch/26362/
http://patchwork.ozlabs.org/patch/26363/
http://patchwork.ozlabs.org/patch/26361/

Oh I see what happened.

Quoted 7 lines

IT'S THOSE STUPID "Date:" fields you added to the body of 2 of those patches. It caused patchwork to put them in the wrong order when I put them together into a bundle.

Don't add extra email header fields like that, please! :-)

I fixed it up and applied the patches.

Thanks, sorry for the extra work.

I did add the headers (Date and From) to preserve the ownership and original date, with plain git it works very well.

I can leave out the date field, but if I resend patch from a other developer (which I signed or acked as maintainer), I need to move the original From into the body, my uplink rewrites the From with my address. Would this be still OK or does the From in the body make also problems with patchwork ?

Other way would be to setup a cloned net-2.6 isdn tree, so you can pull patches directly.

Karsten

maintainer
#9 lore raw

From: Karsten Keil <[email protected]>
Date: Mon, 27 Apr 2009 15:13:32 +0200

Quoted 4 lines

I can leave out the date field, but if I resend patch from a other developer (which I signed or acked as maintainer), I need to move the original From into the body, my uplink rewrites the From with my address. Would this be still OK or does the From in the body make also problems with patchwork ?

Yes, it's perfectly fine to put the author's From: field in the body. And as the patch submitter your should preserve your From: in the normal email headers. That's how it's supposed to be :-)