structure

This commit is contained in:
dzavalishin 2015-06-23 12:03:13 +03:00
parent 8942ad3662
commit 7d94f16f82
13 changed files with 55 additions and 0 deletions

View File

@ -1,2 +1,6 @@
# openpod
OpenPOD portable driver specification sources an examples
NB!
Current state of these sources: raw drafts, not even compiled.

BIN
dox/OpenPOD_0_1.pdf Executable file

Binary file not shown.

1
dox/README Executable file
View File

@ -0,0 +1 @@
Current version of the specification.

1
src/barebones/README Executable file
View File

@ -0,0 +1 @@
This directory contains sceletons of OpenPOD conforming drivers.

1
src/barebones/complex/TODO Executable file
View File

@ -0,0 +1 @@
Need a full featured OpenPOD driver barebone.

2
src/barebones/simple/TODO Executable file
View File

@ -0,0 +1,2 @@
Need a simplest OpenPOD driver barebone.
No threads, no HW scan, no rq queue, the smallest possible one.

1
src/examples/README Executable file
View File

@ -0,0 +1 @@
This directory contains example drivers conforming an OpenPOD specification.

3
src/libs/README Executable file
View File

@ -0,0 +1,3 @@
This directory contains OpenPOD specification related libraries and sources.
All the stuff below is not a part of the specification itself, but is a
helper/support/illustration code.

1
src/libs/openpod_rq/README Executable file
View File

@ -0,0 +1 @@
OpenPOD framework: request queue library.

1
src/openpod/README Executable file
View File

@ -0,0 +1 @@
This directory contains OpenPOD specification related files.

0
src/openpod/openpod.h Executable file
View File

9
src/openpod/pod_kernel_api.h Executable file
View File

@ -0,0 +1,9 @@
#include "pod_types.h"
errno_t pod_dev_link( pod_driver *drv, pod_device *dev ); // Report a new available device to the OS kernel
errno_t pod_dev_unlink( pod_driver *drv, pod_device *dev ); // Report device to be unavailable
errno_t pod_dev_event( pod_driver *drv, pod_device *dev ); // Tell about device event (error? state change?)

31
src/openpod/pod_types.h Executable file
View File

@ -0,0 +1,31 @@
// Hook to use local types definitions
#include "pod_local_types.h"
#ifndef POD_ERRNO_T_DEFINED
#define POD_ERRNO_T_DEFINED
typedef int errno_t;
#endif // POD_ERRNO_T_DEFINED
#ifndef POD_SHORT_TYPES_DEFINED
#define POD_SHORT_TYPES_DEFINED
typedef unsigned char uint8_t;
typedef signed char int8_t;
typedef unsigned int uint32_t;
typedef signed int int32_t;
#endif // POD_SHORT_TYPES_DEFINED