diff --git a/README.md b/README.md index 4ff73a7..2af8634 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # openpod OpenPOD portable driver specification sources an examples + +NB! + +Current state of these sources: raw drafts, not even compiled. diff --git a/dox/OpenPOD_0_1.pdf b/dox/OpenPOD_0_1.pdf new file mode 100755 index 0000000..4548cf1 Binary files /dev/null and b/dox/OpenPOD_0_1.pdf differ diff --git a/dox/README b/dox/README new file mode 100755 index 0000000..21c74c4 --- /dev/null +++ b/dox/README @@ -0,0 +1 @@ +Current version of the specification. diff --git a/src/barebones/README b/src/barebones/README new file mode 100755 index 0000000..4336aac --- /dev/null +++ b/src/barebones/README @@ -0,0 +1 @@ +This directory contains sceletons of OpenPOD conforming drivers. diff --git a/src/barebones/complex/TODO b/src/barebones/complex/TODO new file mode 100755 index 0000000..ef2a57d --- /dev/null +++ b/src/barebones/complex/TODO @@ -0,0 +1 @@ +Need a full featured OpenPOD driver barebone. diff --git a/src/barebones/simple/TODO b/src/barebones/simple/TODO new file mode 100755 index 0000000..cb56f90 --- /dev/null +++ b/src/barebones/simple/TODO @@ -0,0 +1,2 @@ +Need a simplest OpenPOD driver barebone. +No threads, no HW scan, no rq queue, the smallest possible one. diff --git a/src/examples/README b/src/examples/README new file mode 100755 index 0000000..b8ad658 --- /dev/null +++ b/src/examples/README @@ -0,0 +1 @@ +This directory contains example drivers conforming an OpenPOD specification. diff --git a/src/libs/README b/src/libs/README new file mode 100755 index 0000000..c0e529a --- /dev/null +++ b/src/libs/README @@ -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. diff --git a/src/libs/openpod_rq/README b/src/libs/openpod_rq/README new file mode 100755 index 0000000..1fdc183 --- /dev/null +++ b/src/libs/openpod_rq/README @@ -0,0 +1 @@ +OpenPOD framework: request queue library. diff --git a/src/openpod/README b/src/openpod/README new file mode 100755 index 0000000..2debe97 --- /dev/null +++ b/src/openpod/README @@ -0,0 +1 @@ +This directory contains OpenPOD specification related files. diff --git a/src/openpod/openpod.h b/src/openpod/openpod.h new file mode 100755 index 0000000..e69de29 diff --git a/src/openpod/pod_kernel_api.h b/src/openpod/pod_kernel_api.h new file mode 100755 index 0000000..e5eb14d --- /dev/null +++ b/src/openpod/pod_kernel_api.h @@ -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?) diff --git a/src/openpod/pod_types.h b/src/openpod/pod_types.h new file mode 100755 index 0000000..1a13b86 --- /dev/null +++ b/src/openpod/pod_types.h @@ -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 +