Skip to contentSkip to conversation

IDE ioctl documentation & a new ioctl

DISCUSSION Edward Falk 4 participants 6 messages Nov 19, 2004

lore
Share & tools
lore
#0 lore raw

Hi all; let me introduce myself: I'm the guy that does IDE sustaining for Google.

I'm getting ready to sit down and document the IDE ioctls. Probably Documentation/hdio.txt or something like that. Before I start though, is anybody already doing this?

And while I'm on the subject, we're getting ready to write a new hdio ioctl, an extension of HDIO_DRIVE_CMD. The intent here is to be slightly more general-purpose than HDIO_DRIVE_CMD, with an eye to supporting the full set of SMART functionality. Current plan is to have the user pass a struct containing a pointer to the argument list, a pointer to the data buffer, and a data buffer length value. Consider this a design document; any comments and/or feature requests?

-ed falk
[email protected]

#1 lore raw
Quoted 4 lines · Edward Falk

Hi all; let me introduce myself: I'm the guy that does IDE sustaining for Google.

I'm getting ready to sit down and document the IDE ioctls. Probably Documentation/hdio.txt or something like that. Before I start though, is anybody already doing this?

No one that I know of. I had a thought in the back of my head of tackling ioctl documentation after I went through the stuff that's already in Documentation, but I figured I had enough to chew on for right now.

I'd probably make a subdirectory - i. e. Documentation/ioctl/hdio.txt - to differentiate it from other documents, and make it easier to get maintainers to put some stuff in there. ;) AFAICT, there is next to no documentation on ioctl's anywhere in the kernel tarball.

Quoted 5 lines

And while I'm on the subject, we're getting ready to write a new hdio ioctl, an extension of HDIO_DRIVE_CMD. The intent here is to be slightly more general-purpose than HDIO_DRIVE_CMD, with an eye to supporting the full set of SMART functionality. Current plan is to have the user pass a struct containing a pointer to the argument list, a pointer to the data buffer, and a data buffer length value. Consider this a design document; any comments and/or feature requests?

-ed falk
[email protected]
-

#2 lore raw
Quoted 2 lines

I'd probably make a subdirectory - i. e. Documentation/ioctl/hdio.txt - to differentiate it from other documents, and make it easier to get maintainers to put some stuff in there. ;) AFAICT, there is next to no documentation on ioctl's anywhere in the kernel tarball.

Good point; the existance of an ioctl subdirectory would encourage others to write documentation as well.

#3 lore raw
In reply to Edward Falk
Quoted 1 line · Edward Falk

And while I'm on the subject, we're getting ready to write a new hdio ioctl, an extension of HDIO_DRIVE_CMD. The intent here is to be slightly more general-purpose than HDIO_DRIVE_CMD, with an eye to supporting the full set of SMART functionality. Current plan is to have the user pass a struct containing a pointer to the argument list, a pointer to the data buffer, and a data buffer length value. Consider this a design document; any comments and/or feature requests?

HDIO_DRIVE_TASK and flagged taskfiles should cover everything you need.

Jeff

#4 lore raw
Quoted 2 lines

HDIO_DRIVE_TASK and flagged taskfiles should cover everything you need.

I'll take another look. Thanks.

-ed falk

#5 lore raw
In reply to Jeff Garzik

Hi!

Documenting existing ioctls would be appreciated by many people...

Quoted 10 lines · Jeff Garzik
Quoted 7 lines · Edward Falk

And while I'm on the subject, we're getting ready to write a new hdio ioctl, an extension of HDIO_DRIVE_CMD. The intent here is to be slightly more general-purpose than HDIO_DRIVE_CMD, with an eye to supporting the full set of SMART functionality. Current plan is to have the user pass a struct containing a pointer to the argument list, a pointer to the data buffer, and a data buffer length value. Consider this a design document; any comments and/or feature requests?

HDIO_DRIVE_TASK and flagged taskfiles should cover everything you need.

HDIO_DRIVE_TASKFILE for (flagged) taskfiles and commands requiring data transfers.

Bartlomiej