ntp/ntpd/refclock_oncore.c

6  * this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
75  * driver not starting up, and it is often because of signal strength being low.
82  * Add back in @@Bl code to do the @@Bj/@@Gj that is in later ONCOREs
85  * before the leap second is to be applied, but in practice at least some of
86  * the receivers turn this indicator on as soon as the message is posted, which
131  *  state machine state) are printed to CLOCKSTATS if that file is enabled
137  * doing an average of 10000 valid 2D and 3D fixes is what the automatic
139  * it seems like it is only using 3D fixes.
255 /* It is possible to test the VP/UT each cycle (@@Ea or equivalent) to
256  * see what mode it is in.  The bits on the M12 are multiplexed with
427  * Understanding the next bit here is not easy unless you have a manual
641 	 * This is a bit complicated, a we dont want to open the same file twice
663 	   Note that the linuxPPS N_PPS file is just like a N_TTY, so we can do
692 	/* for LINUX the PPS device is the result of a line discipline.
746 	 * an old one is found.
892 	/* only set what is legal */
901 	/* If HARDPPS is on, we tell kernel */
913 		/* we know that 'i' is legal from above */
942 	* The first thing we do is see if there is an instance->shmem_fname file (still)
1071 		     "SHMEM (size = %ld) is CONFIGURED and available as %s",
1090  * where N is the unit number viz 127.127.30.N.
1100  *    (0) ONCORE is preinitialized, don't do anything to change it.
1108  *     NB. If a POSITION is specified in the config file with mode=(2,4) [SITE SURVEY]
1109  *	   then this position is set as the INITIAL position of the ONCORE.
1112  * Note that an Oncore UT without a battery backup retains NO information if it is
1114  * For an Oncore VP, there is an eeprom that will contain this data, along with the
1116  * So a UT without Battery Backup is equivalent to doing a HARD RESET on each
1117  *   power cycle, since there is nowhere to store the data.
1128  *	# is comment to end of line
1141  *	   followed by 1-2 fields.  First is a number, the second is 'FT' or 'M'
1142  *	   for feet or meters.	HT is the height above the GPS ellipsoid.
1146  *	There is an optional line, starting with DELAY, followed
1147  *	   by 1 or two fields.	The first is a number (a time) the second is
1149  *	    DELAY  is cable delay, typically a few tens of ns.
1151  *	There is an optional line, starting with OFFSET, followed
1152  *	   by 1 or two fields.	The first is a number (a time) the second is
1154  *	   OFFSET is the offset of the PPS pulse from 0. (only fully implemented
1156  *		offset if the Kernel PLL is in use, but can only do this presently
1158  *		then there is no problem.
1160  *	There is an optional line, with either ASSERT or CLEAR on it, which
1161  *	   determine which transition of the PPS signal is used for timing by the
1162  *	   PPSAPI.  If neither is present, then ASSERT is assumed.
1164  *	   For Flag2, ASSERT=0, and hence is default.
1166  *	There is an optional line, with HARDPPS on it.	Including this line causes
1169  *	   For Flag3, 0 is disabled, and the default.
1173  *	   The file name is the file associated with the shared memory.
1175  *	In shared memory, there is one 'record' for each returned variable.
1180  *	   record is filled once every 15s.
1188  *	There is an optional line with MASK on it followed by one integer field in the
1191  *	   is 10 deg for the VP and 0 deg for all other receivers.
1193  *	There is an optional line with PPSCONTROL on it (only valid for M12 or M12+T
1194  *	   receivers, the option is read, but ignored for all others)
1195  *	   and it is followed by:
1196  *		ON	   Turn PPS on.  This is the default and the default for other
1197  *			       oncore receivers.  The PPS is on even if not tracking
1201  *	  The OFF option is NOT implemented, since the Oncore driver will not work
1374 			instance->traim_in = 1; 	/* so TRAIM alone is YES */
1385 				instance->pps_control = 2;		/* PPS on when satellite is available */
1387 				instance->pps_control = 3;		/* PPS on when TRAIM status is OK */
1602 	 *  times we get here in 0D mode (the 1/15 is in 3D for SHMEM).
1603 	 * This gives good time, which gets better when the SS is done.
1623 	/* Once the Almanac is valid, the M12+T does not produce valid UTC
1713      alternate code for previous 4 lines is
1733 	/* offset in ns, and is positive (late), we subtract */
1744 	/* The following code is necessary, and not just a time_pps_setparams,
1747 	 * that it needs).  We take what is there and ADD what we need.
1748 	 * [[ The results from the time_pps_getcap is unlikely to change so
1750 	 * Unfortunately, there is only ONE set of mode bits in the kernel per
1753 	 * There is still a race condition here where we might mess up someone
1754 	 * elses mode, but if he is being careful too, he should survive.
1881 	oncore_log(instance, LOG_INFO, Msg);	 /* this is long message above */
1992 		cp = "is";
2051  * Nb. @@Ay is not supported for early UT (no plus) model
2068 	oncore_log_f(instance, LOG_INFO, "PPS Offset is set to %ld ns",
2092 	oncore_log_f(instance, LOG_INFO, "Cable delay is set to %ld ns",
2177 	/* check the antenna (did it get unplugged) and almanac (is it ready) for changes. */
2245 	/* Unfortunately, the Gd3 command returns '3' for the M12 v1.3 firmware where it is
2248 	 * then check Ha[130]&0x10 to see if a SS is in progress.
2276 					 * ONCORE_SS_HW.  If the Hardware is capable of doing a Site Survey, then
2462  * It turns on the LEAP indicator when the data is set, and does not,
2466  * @@Bj is only called in June/December.
2680  * sleep(2) is wasteful, and may cause trouble for some OS's, repeating
2682  * been cleared, we reissue the @@Cj that is issued below.
2684  * The first is to get the info, the 2nd is just used as a safe command
2778 		oncore_log(instance, LOG_NOTICE, "Cb: Response is NO ALMANAC");
2819  * This is the Grand Central Station for the Preliminary Initialization.
2826  *   This info is printed, but no longer used.
2878  * Determine the Type from the Model #, this determines #chan and if TRAIM is
2881  * The Information from this routine is NO LONGER USED.
2913 	/* from model number decide which Oncore this is,
3035 	/* If there is Position input in the Config file
3166 		     "Date/Time set to: %d%s%d %2d:%02d:%02d GMT (GMT offset is %s%02d:%02d)",
3226 	 * get the actual leap second -- that is, the one that is
3229 	 * Going through all this for a simple log is probably overkill,
3230 	 * so for fixing bug#1050 the message output is changed to
3311 	 * model number of the attached oncore.  This is not always correct since
3316 	 * This #chan is used by the code rather than that calculated from the model number.
3396  * Note that the ONCORE firmware for the Bj command is wrong at
3399  * data message (page 18, subframe 4) is updated to a date in the
3402  * Since there is a one bit flag, there is no way to tell if it is
3412  * interpret it ourselves, but since this is specific to this receiver
3413  * only, and the above workaround is adequate, we don't bother.
3432 		if (instance->saw_Gj == 0)	/* 0 is dont know if we have Gj */
3461  *  len is length WITH CR/LF.
3502 	/* if MSL is not set, the calculation is meaningless */
3694 	int idx, idy, is, imx, imy;
3733 	is  = lat%60000;
3734 	xs  = is/1000.;
3735 	is  = lon%60000;
3736 	ys  = is/1000.;
4007 		 * Check if we have a SHMEM, and if so try to load whatever is there.
4075 			    "Max Message Length so far is %d",