/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) fill_darray.c 1.20 05/08/19 SwRI" #include "libbase_idfs.h" #include "ret_codes.h" /**************************************************************************** * * * IR_FILL_DATA_ARRAY SUBROUTINE * * * * DESCRIPTION * * This routine fills in the data structure with the data for requested * * sensor/time period combination. The algorithms for extracting the data * * are dependent upon the size of the data elements (in bits). As the * * program stands, it will handle data up to 32 bits in length. For * * larger sizes, code must be added. * * * * INPUT VARIABLES * * SDDAS_LONG sen_index gives position of sensors in sensor set * * SDDAS_CHAR full_swp flag indicating if 1 or all of the values * * in the sensor set are to be retreived (for * * scalar sensors only) * * void *idf_data_ptr ptr to memory location for the structure * * that holds returned data values (read_drec)* * * * USAGE * * x = ir_fill_data_array (sen_index, full_swp, idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * struct general_info structure holding information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * reg SDDAS_LONG *ret_ptr ptr to the array where data is returned * * register SDDAS_ULONG *lpt data is interpreted as an array of longs * * register SDDAS_USHORT *s1 data is interpreted as an array of shorts * * register SDDAS_UCHAR *ucpt data is interpreted as an array of chars * * register SDDAS_UCHAR *uc1 pointer to the mask/shift array * * SDDAS_LONG num_bytes number of bytes to bypass in order to get * * to the current sensor set * * SDDAS_LONG offset current bit pointed to within the sensor * * set for bit data * * SDDAS_LONG *stop_loop loop termination variable * * SDDAS_USHORT max_elements the number of data values to be processed * * SDDAS_USHORT n_sample the no. of samples returned for each sensor* * SDDAS_SHORT result temporary value * * stat SDDAS_UCHAR one_bit_mask[] mask giving the bit of interest * * stat SDDAS_UCHAR two_bit_shift[] no. of bits to shift to get two bits* * of interest to the last 2 bits in the byte * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_SHORT ir_fill_data_array (SDDAS_LONG sen_index, SDDAS_CHAR full_swp, void *idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; register SDDAS_LONG *ret_ptr; register SDDAS_ULONG *lpt; register SDDAS_USHORT *s1; register SDDAS_UCHAR *ucpt, *uc1; SDDAS_LONG num_bytes, offset, *stop_loop; SDDAS_USHORT max_elements, n_sample; SDDAS_SHORT result; static SDDAS_UCHAR one_bit_mask[8] = {128, 64, 32, 16, 8, 4, 2, 1}; static SDDAS_UCHAR two_bit_shift[4] = {6, 4, 2, 0}; /***********************************************************************/ /* Set a pointer to structure which holds all pointers for header and */ /* data information for the experiment currently being processed. */ /***********************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; /****************************************************************************/ /* No need to make sure data structure is correct type or that the header */ /* format is correct since this module is indirectly called by read_drec() */ /* which checks for this issue. */ /****************************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; /********************************************************************/ /* For a full swp, max_elements is not just set to N_SAMPLE because */ /* user could have asked for 1 at a time and changed to a full swp */ /* to get remainder of elements. We use time_row since we need to */ /* pick up rest of the elements in that column being processed (for */ /* both SEN_MODE = 0 & 4) and time_row tells how many have already */ /* been processed for that sensor. */ /********************************************************************/ n_sample = *ptr->hdr_fmt1_ptr->N_SAMPLE; max_elements = (ex->smp_id == 2 && !full_swp) ? 1 : n_sample - ptr->time_row; /**********************************************************************/ /* Determine the number of bits needed to be bypassed to get to the */ /* current sensor set. Convert that number to bytes (partial bytes */ /* included). */ /**********************************************************************/ num_bytes = ex->accum_ss_sz / 8; if (ex->accum_ss_sz % 8 != 0) ++num_bytes; /********************************************************************/ /* Set pointers to the returned data array and to the position of */ /* the last data value to be returned */ /********************************************************************/ ret_ptr = EXP_DATA->sen_data; stop_loop = ret_ptr + max_elements; /**********************************************************************/ /* The data elements are packed into a byte. (Bit information. */ /**********************************************************************/ if (ex->tdw_len < 8) { /******************************************************************/ /* Following switch pulls out data for different bit lengths. */ /* Each case statement does the same */ /* 1) Set offset to data, this includes offsets into the current */ /* sensor set, the sensor position, and sensor sample */ /* 2) Set base pointer to data */ /* 3) Loop over all of the elements */ /* A) Find byte which has sensor data and set pointer to it */ /* B) Mask off data */ /* C) If necessary shift data into position */ /* */ /* Note that this data acquisition algorithm assumes that a each */ /* sensor set begins as a NEW byte. That is one byte cannot */ /* contain data from two sensor sets */ /* */ /* For all for loops, it's advised to use ++x instead of x++ */ /* for optimization purposes. */ /******************************************************************/ switch (ex->tdw_len) { case 1: offset = n_sample * sen_index + ptr->time_row; ucpt = (SDDAS_UCHAR *) (ptr->DATA + num_bytes); uc1 = one_bit_mask; for (; ret_ptr < stop_loop; ++offset, ++ret_ptr) { result = *(ucpt + offset/8) & *(uc1 + offset % 8); *ret_ptr = (result != 0) ? 1 : result; } break; case 2: offset = (n_sample * sen_index + ptr->time_row) << 1; ucpt = (SDDAS_UCHAR *) (ptr->DATA + num_bytes); uc1 = two_bit_shift; for (; ret_ptr < stop_loop; offset += 2, ++ret_ptr) { result = *(ucpt + offset/8) >> *(uc1 + (offset % 8)/2); *ret_ptr = result & 3; } break; case 3: offset = (n_sample * sen_index + ptr->time_row) << 2; ucpt = (SDDAS_UCHAR *) (ptr->DATA + num_bytes); for (; ret_ptr < stop_loop; offset += 4, ++ret_ptr) { result = (offset % 8 == 0) ? *(ucpt + offset / 8) >> 4 : *(ucpt + offset / 8); *ret_ptr = result & 7; } break; case 4: offset = (n_sample * sen_index + ptr->time_row) << 2; ucpt = (SDDAS_UCHAR *) (ptr->DATA + num_bytes); for (; ret_ptr < stop_loop; offset += 4, ++ret_ptr) { result = (offset % 8 == 0) ? *(ucpt + offset / 8) >> 4 : *(ucpt + offset / 8); *ret_ptr = result & 15; } break; default: ucpt = (SDDAS_UCHAR *) (ptr->DATA + num_bytes + n_sample * sen_index + ptr->time_row); for (; ret_ptr < stop_loop; ++ret_ptr, ++ucpt) *ret_ptr = *ucpt; break; } } /******************************************************************/ /* The data requires one or more bytes per element. */ /******************************************************************/ else { /*******************************************************************/ /* Determine the number of bytes per data element. Data and cal. */ /* data are the same size (bytes). The premise at this time is */ /* that all data is <= 32 bits in length. Data is laid down in 1, */ /* 2, or 4 bytes. */ /*******************************************************************/ if (ex->tdw_len == 8) { ucpt = ptr->DATA + num_bytes + n_sample * sen_index + ptr->time_row; for (; ret_ptr < stop_loop; ++ret_ptr, ++ucpt) *ret_ptr = *ucpt; } else if (ex->tdw_len <= 16) /* interpret as shorts */ { s1 = (SDDAS_USHORT *) (ptr->DATA + num_bytes + n_sample * sizeof (SDDAS_USHORT) * sen_index + sizeof (SDDAS_USHORT) * ptr->time_row); for (; ret_ptr < stop_loop; ++ret_ptr, ++s1) *ret_ptr = *s1; } else /* interpret as longs */ { lpt = (SDDAS_ULONG *) (ptr->DATA + num_bytes + n_sample * sizeof (SDDAS_ULONG) * sen_index + sizeof (SDDAS_ULONG) * ptr->time_row); for (; ret_ptr < stop_loop; ++ret_ptr, ++lpt) *ret_ptr = *lpt; } } EXP_DATA->num_sample = max_elements; return (ALL_OKAY); }