[Xenomai-core] Some doc improvements

[Xenomai-core] Some doc improvements

[Wolfgang Grandegger]

[-- Attachment #1: Type: text/plain, Size: 475 bytes --]

Hello,

attached is a patch improving the Doxygen generated documentation. If 
nobody complains, I will commit it to the trunk. Nevertheless, it 
remains the problem, that some symbols are not hyperlinked, mainly most 
of the rt_dev_* functions. For some strange reasons it works for a few, 
e.g. rt_dev_setsockopt. I tried Doxygen v1.5.1, which didn't help (but 
it has the nice frames, BTW). I'm going to report the problem on the 
Doxygen ML when time permits.

Wolfgang.

[-- Attachment #2: xenomai-doc-improvements.patch --]
[-- Type: text/x-patch, Size: 5724 bytes --]

Index: include/rtdm/rttesting.h
===================================================================
--- include/rtdm/rttesting.h	(revision 2239)
+++ include/rtdm/rttesting.h	(working copy)
@@ -50,8 +50,8 @@
  * Specific return values: none @n
  * @n
  * @b IOCTL @n
- * Mandatory Environments: see @ref IOCTLs below @n
- * Specific return values: see @ref IOCTLs below @n
+ * Mandatory Environments: see @ref TSTIOCTLs below @n
+ * Specific return values: see @ref TSTIOCTLs below @n
  *
  * @{
  */
@@ -153,7 +153,7 @@ struct rttst_swtest_error {
 
 
 /*!
- * @anchor IOCTLs @name IOCTLs
+ * @anchor TSTIOCTLs @name IOCTLs
  * Testing device IOCTLs
  * @{ */
 #define RTTST_RTIOC_INTERM_BENCH_RES \
Index: include/rtdm/rtserial.h
===================================================================
--- include/rtdm/rtserial.h	(revision 2239)
+++ include/rtdm/rtserial.h	(working copy)
@@ -50,8 +50,8 @@
  * Specific return values: none @n
  * @n
  * @b IOCTL @n
- * Mandatory Environments: see @ref IOCTLs "below" @n
- * Specific return values: see @ref IOCTLs "below" @n
+ * Mandatory Environments: see @ref SERIOCTLs "below" @n
+ * Specific return values: see @ref SERIOCTLs "below" @n
  * @n
  * @b Read @n
  * Environments: RT (non-RT optional)@n
@@ -312,7 +312,7 @@ typedef struct rtser_event {
 
 
 /*!
- * @anchor IOCTLs @name IOCTLs
+ * @anchor SERIOCTLs @name IOCTLs
  * Serial device IOCTLs
  * @{ */
 
@@ -460,7 +460,7 @@ typedef struct rtser_event {
 /** @} */
 
 /*!
- * @anchor RTSERutils @name RT Serial example and utility programs
+ * @anchor SERutils @name RT Serial example and utility programs
  * @{ */
 /** @example cross-link.c */
 /** @} */
Index: include/rtdm/rtcan.h
===================================================================
--- include/rtdm/rtcan.h	(revision 2239)
+++ include/rtdm/rtcan.h	(working copy)
@@ -78,8 +78,8 @@
  * @n
  * @n
  * @b IOCTL @n
- * Mandatory Environments: see @ref IOCTLs "below" @n
- * Specific return values: see @ref IOCTLs "below" @n
+ * Mandatory Environments: see @ref CANIOCTLs "below" @n
+ * Specific return values: see @ref CANIOCTLs "below" @n
  * @n
  * @n
  * @anchor Bind
@@ -252,7 +252,7 @@
 
 #include <rtdm/rtdm.h>
 
-#define RTCAN_PROFILE_VER           2
+#define RTCAN_PROFILE_VER  2
 
 #ifndef AF_CAN
 
@@ -264,6 +264,18 @@
 
 #endif
 
+/** Particular CAN protocols
+ *
+ *  Currently only the RAW protocol is supported.
+ */
+#define CAN_RAW  0
+
+/** CAN socket levels
+ *
+ *  Used for @ref Sockopts for the particular protocols.
+ */
+#define SOL_CAN_RAW  103
+
 /** Type of CAN id (see @ref CAN_xxx_MASK and @ref CAN_xxx_FLAG) */
 typedef uint32_t can_id_t;
 typedef uint32_t canid_t;
@@ -306,7 +318,7 @@ typedef can_id_t can_err_mask_t;
  * Possible protocols for PF_CAN protocol family
  * @{ */
 enum CAN_PROTO {
-    /** Raw protocol of @c PF_CAN, applicable to socket 
+    /** Raw protocol of @c PF_CAN, applicable to socket
 	type @c SOCK_RAW */
     CAN_PROTO_RAW,
     CAN_PROTO_MAX
@@ -527,9 +539,6 @@ typedef struct can_frame {
 
 #define RTIOC_TYPE_CAN              RTDM_CLASS_CAN
 
-
-#define SOL_CAN_RAW 103
-
 /*!
  * @anchor Rawsockopts @name RAW socket options
  * Setting and getting CAN RAW socket options.
@@ -631,7 +640,7 @@ typedef struct can_frame {
 /** @} */
 
 /*!
- * @anchor IOCTLs @name IOCTLs
+ * @anchor CANIOCTLs @name IOCTLs
  * CAN device IOCTLs
  * @{ */
 
Index: src/utils/can/rtcansend.c
===================================================================
--- src/utils/can/rtcansend.c	(revision 2239)
+++ src/utils/can/rtcansend.c	(working copy)
@@ -216,7 +216,7 @@ int main(int argc, char **argv)
     if (verbose)
 	printf("interface %s\n", argv[optind]);
 
-    ret = rt_dev_socket(PF_CAN, SOCK_RAW, 0);
+    ret = rt_dev_socket(PF_CAN, SOCK_RAW, CAN_RAW);
     if (ret < 0) {
 	fprintf(stderr, "rt_dev_socket: %s\n", strerror(-ret));
 	return -1;
Index: src/utils/can/rtcanrecv.c
===================================================================
--- src/utils/can/rtcanrecv.c	(revision 2239)
+++ src/utils/can/rtcanrecv.c	(working copy)
@@ -236,7 +236,7 @@ int main(int argc, char **argv)
 	}
     }
 
-    ret = rt_dev_socket(PF_CAN, SOCK_RAW, 0);
+    ret = rt_dev_socket(PF_CAN, SOCK_RAW, CAN_RAW);
     if (ret < 0) {
 	fprintf(stderr, "rt_dev_socket: %s\n", strerror(-ret));
 	return -1;
Index: src/utils/can/rtcanconfig.c
===================================================================
--- src/utils/can/rtcanconfig.c	(revision 2239)
+++ src/utils/can/rtcanconfig.c	(working copy)
@@ -168,7 +168,7 @@ int main(int argc, char *argv[])
 	}
     }
 
-    can_fd = rt_dev_socket(PF_CAN, SOCK_RAW, 0);
+    can_fd = rt_dev_socket(PF_CAN, SOCK_RAW, CAN_RAW);
     if (can_fd < 0) {
 	fprintf(stderr, "Cannot open RTDM CAN socket. Maybe driver not loaded? \n");
 	return can_fd;
Index: ksrc/skins/native/task.c
===================================================================
--- ksrc/skins/native/task.c	(revision 2239)
+++ ksrc/skins/native/task.c	(working copy)
@@ -42,6 +42,7 @@
 /** @example kernel_task.c */
 /** @example bound_task.c */
 /** @example sigxcpu.c */
+/** @example trivial-periodic.c */
 
 #include <nucleus/pod.h>
 #include <nucleus/heap.h>
Index: examples/rtdm/profiles/can/rtcan_rtt.c
===================================================================
--- examples/rtdm/profiles/can/rtcan_rtt.c	(revision 2239)
+++ examples/rtdm/profiles/can/rtcan_rtt.c	(working copy)
@@ -237,7 +237,7 @@ int main(int argc, char *argv[])
     rxdev = argv[optind + 1];
 
     /* Create and configure RX socket */
-    if ((rxsock = socket(PF_CAN, SOCK_RAW, 0)) < 0) {
+    if ((rxsock = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
 	perror("RX socket failed");
 	return -1;
     }

Re: [Xenomai-core] Some doc improvements

[Jan Kiszka]

[-- Attachment #1: Type: text/plain, Size: 1382 bytes --]

Wolfgang Grandegger wrote:
> Hello,
> 
> attached is a patch improving the Doxygen generated documentation. If
> nobody complains, I will commit it to the trunk. Nevertheless, it
> remains the problem, that some symbols are not hyperlinked, mainly most
> of the rt_dev_* functions. For some strange reasons it works for a few,
> e.g. rt_dev_setsockopt. I tried Doxygen v1.5.1, which didn't help (but

Maybe due to the ugly doxy-hacks that I applied all over RTDM. Making
doxygen output work AND look nice seems to be an endless journey.

> it has the nice frames, BTW). I'm going to report the problem on the
> Doxygen ML when time permits.
> 
> Wolfgang.
> 
> 
> ------------------------------------------------------------------------
> 
> Index: include/rtdm/rttesting.h
> ===================================================================
> --- include/rtdm/rttesting.h	(revision 2239)
> +++ include/rtdm/rttesting.h	(working copy)
> @@ -50,8 +50,8 @@
>   * Specific return values: none @n
>   * @n
>   * @b IOCTL @n
> - * Mandatory Environments: see @ref IOCTLs below @n
> - * Specific return values: see @ref IOCTLs below @n
> + * Mandatory Environments: see @ref TSTIOCTLs below @n
> + * Specific return values: see @ref TSTIOCTLs below @n

I also spotted this, good that you address it!

Ack to the whole from my side.

Thanks,
Jan


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 250 bytes --]

[Xenomai-core] Xenomai on MIPS intial boot

[somshekar kadam]

Hi All, 

   I have implelented Xenomai for MIPS , as due to
some legal issues with project completion, I can
submit for Open source. I hope this is understood. 

Initial code is put for mips architecture related. 
There are two issues right now I am facing, throw some
light on this. 

Issue 1 

1) Implementing Xnpod_start_thread, for Mips involves
xnarch_init_thread, I checked other architectures,
what I get it only a stack initilaisation for the new
tthread, correct me if I am wrong, I am not able to
fix other thread_info parametters for this function
only. I have booted the Xenomai without thead creation
able to see Xenomai registered as domain and starting
API services. I am testing the invoking of Syscalls
happening proper, yet to be done to prove services are
working fine. Does anybody have any pointer on this
xnarch_init_thread.

Issue2 

To check the APIS services are implemented , I trying
to create the /usr/xenomai libe for application by
compiling Xenomai by configuring 
./configure --target=mips --host=i386 --enable-shared
CC=mips_fp_be-gcc 
configured properly after this command
then I say make command

it is giving me  "impossible constraint asm"
to create alarm lib for xenomai. 

I made chaanges to support MIPS in configure.in, also
in the config.status to create
include/asm-mips/Makefile, and
iclude/asm-mips/bits/Makefile. 
These file are created and compile it still impossibel
constarint asm error persists.

I even disabled the optimization -O2 option , no
change, I am lost please give any pointers on this. 
is not the proper arch getting the one is it GCC
related bug, I need to check 

Yes I know its long mail. 

Thanks And Regards
Neelu


		
__________________________________________________________
Yahoo! India Answers: Share what you know. Learn something new
http://in.answers.yahoo.com/

Re: [Xenomai-core] Xenomai on MIPS intial boot

[Gilles Chanteperdrix]

somshekar kadam wrote:
> ./configure --target=mips --host=i386 --enable-shared
> CC=mips_fp_be-gcc 

What you probably want is ./configure --host=mips


-- 
                                                 Gilles Chanteperdrix

Re: [Xenomai-core] Xenomai on MIPS intial boot

[Gilles Chanteperdrix]

somshekar kadam wrote:
 > 
 > Hi All, 
 > 
 >    I have implelented Xenomai for MIPS , as due to
 > some legal issues with project completion, I can
 > submit for Open source. I hope this is understood. 

Actually, it is not understood. What do you mean, you can or can not
submit your work to open-source ?

-- 


					    Gilles Chanteperdrix.

Re: [Xenomai-core] Xenomai on MIPS intial boot

[somshekar kadam]

Hi Gilles, 

  Right now I cant submit it, may be in the first week
of APRIL I will submit it. After my client accepts the
port and we shall submit it to open source. Right now
compiled lib for xenomai, when i say make install got
some recursive error, and all lib are created as
libnative.a , I dont understand why shared libs are
not created in the configure command for xenomai I
give 
./configure --host=mips --prefix=/opt/neelu/xen
--enable-shared=libnative CC=mips_fp_be-gcc. 

next command make 
nex command make install 
gives error, what I see is asm-mips soft link is
broken, i created it manually still not working any
pointers on this. 

Thanks And Regards
Neelu




--- Gilles Chanteperdrix
<gilles.chanteperdrix@xenomai.org> wrote:

> somshekar kadam wrote:
>  > 
>  > Hi All, 
>  > 
>  >    I have implelented Xenomai for MIPS , as due
> to
>  > some legal issues with project completion, I can
>  > submit for Open source. I hope this is
> understood. 
> 
> Actually, it is not understood. What do you mean,
> you can or can not
> submit your work to open-source ?
> 
> -- 
> 
> 
> 					    Gilles Chanteperdrix.
> 



		
__________________________________________________________
Yahoo! India Answers: Share what you know. Learn something new
http://in.answers.yahoo.com/

Re: [Xenomai-core] Xenomai on MIPS intial boot

[Philippe Gerum]

On Thu, 2007-03-15 at 10:45 +0000, somshekar kadam wrote:
> Hi Gilles, 
> 
>   Right now I cant submit it, may be in the first week
> of APRIL I will submit it. After my client accepts the
> port and we shall submit it to open source.

Great, so I suggest that we talk about the following issues
maybe, say, by the first week of April.

>  Right now
> compiled lib for xenomai, when i say make install got
> some recursive error, and all lib are created as
> libnative.a , I dont understand why shared libs are
> not created in the configure command for xenomai I
> give 
> ./configure --host=mips --prefix=/opt/neelu/xen
> --enable-shared=libnative CC=mips_fp_be-gcc. 
> 
> next command make 
> nex command make install 
> gives error, what I see is asm-mips soft link is
> broken, i created it manually still not working any
> pointers on this. 
> 
> Thanks And Regards
> Neelu
> 
> 
> 
> 
> --- Gilles Chanteperdrix
> <gilles.chanteperdrix@xenomai.org> wrote:
> 
> > somshekar kadam wrote:
> >  > 
> >  > Hi All, 
> >  > 
> >  >    I have implelented Xenomai for MIPS , as due
> > to
> >  > some legal issues with project completion, I can
> >  > submit for Open source. I hope this is
> > understood. 
> > 
> > Actually, it is not understood. What do you mean,
> > you can or can not
> > submit your work to open-source ?
> > 
> > -- 
> > 
> > 
> > 					    Gilles Chanteperdrix.
> > 
> 
> 
> 
> 		
> __________________________________________________________
> Yahoo! India Answers: Share what you know. Learn something new
> http://in.answers.yahoo.com/
> 
> _______________________________________________
> Xenomai-core mailing list
> Xenomai-core@domain.hid
> https://mail.gna.org/listinfo/xenomai-core
-- 
Philippe.

Re: [Xenomai-core] Xenomai on MIPS intial boot

[somshekar kadam]

Hi Philipe, 

    Yes definately , we will talk and need your
guidance to make it perfect, right now looking into
syscall and xnarch_init_thread, once minimal is
working , I will get back to you. 
we are seeing now its able to go in syscall and
failing to create task , this is the last hurdle,
which we need to cross. now I am able to install
libraries for xenomai, one thing I dont understand is
its not able to create shared lib, for time being made
it static and debuging. any pointers on this will be
useful. 

Thanks And Regards
Neelu




--- Philippe Gerum <rpm@xenomai.org> wrote:

> On Thu, 2007-03-15 at 10:45 +0000, somshekar kadam
> wrote:
> > Hi Gilles, 
> > 
> >   Right now I cant submit it, may be in the first
> week
> > of APRIL I will submit it. After my client accepts
> the
> > port and we shall submit it to open source.
> 
> Great, so I suggest that we talk about the following
> issues
> maybe, say, by the first week of April.
> 
> >  Right now
> > compiled lib for xenomai, when i say make install
> got
> > some recursive error, and all lib are created as
> > libnative.a , I dont understand why shared libs
> are
> > not created in the configure command for xenomai I
> > give 
> > ./configure --host=mips --prefix=/opt/neelu/xen
> > --enable-shared=libnative CC=mips_fp_be-gcc. 
> > 
> > next command make 
> > nex command make install 
> > gives error, what I see is asm-mips soft link is
> > broken, i created it manually still not working
> any
> > pointers on this. 
> > 
> > Thanks And Regards
> > Neelu
> > 
> > 
> > 
> > 
> > --- Gilles Chanteperdrix
> > <gilles.chanteperdrix@xenomai.org> wrote:
> > 
> > > somshekar kadam wrote:
> > >  > 
> > >  > Hi All, 
> > >  > 
> > >  >    I have implelented Xenomai for MIPS , as
> due
> > > to
> > >  > some legal issues with project completion, I
> can
> > >  > submit for Open source. I hope this is
> > > understood. 
> > > 
> > > Actually, it is not understood. What do you
> mean,
> > > you can or can not
> > > submit your work to open-source ?
> > > 
> > > -- 
> > > 
> > > 
> > > 					    Gilles Chanteperdrix.
> > > 
> > 
> > 
> > 
> > 		
> >
>
__________________________________________________________
> > Yahoo! India Answers: Share what you know. Learn
> something new
> > http://in.answers.yahoo.com/
> > 
> > _______________________________________________
> > Xenomai-core mailing list
> > Xenomai-core@domain.hid
> > https://mail.gna.org/listinfo/xenomai-core
> -- 
> Philippe.
> 
> 
> 



		
__________________________________________________________
Yahoo! India Answers: Share what you know. Learn something new
http://in.answers.yahoo.com/