transform.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation.
   3  */
   4
   5 #include <stdlib.h>
   6 #include <math.h>
   7 #include <utils/Log.h>
   8 #include <cutils/properties.h>
   9 #include <hardware/sensors.h>
  10 #include "calibration.h"
  11 #include "common.h"
  12 #include "description.h"
  13 #include "transform.h"
  14 #include "utils.h"
  15 #include "filtering.h"
  16
  17
  18 #define GYRO_MIN_SAMPLES 5 /* Drop first few gyro samples after enable */
  19
  20
  21 /*----------------------------------------------------------------------------*/
  22
  23
  24 /* Macros related to Intel Sensor Hub */
  25
  26 #define GRAVITY         9.80665
  27
  28 /* 720 LSG = 1G */
  29 #define LSG             1024.0
  30 #define NUMOFACCDATA    8.0
  31
  32 /* Conversion of acceleration data to SI units (m/s^2) */
  33 #define CONVERT_A       (GRAVITY_EARTH / LSG / NUMOFACCDATA)
  34 #define CONVERT_A_X(x)  ((float(x) / 1000) * (GRAVITY * -1.0))
  35 #define CONVERT_A_Y(x)  ((float(x) / 1000) * (GRAVITY * 1.0))
  36 #define CONVERT_A_Z(x)  ((float(x) / 1000) * (GRAVITY * 1.0))
  37
  38 /* Conversion of magnetic data to uT units */
  39 #define CONVERT_M       (1.0 / 6.6)
  40 #define CONVERT_M_X     (-CONVERT_M)
  41 #define CONVERT_M_Y     (-CONVERT_M)
  42 #define CONVERT_M_Z     (CONVERT_M)
  43
  44 #define CONVERT_GAUSS_TO_MICROTESLA(x)  ((x) * 100)
  45
  46 /* Conversion of orientation data to degree units */
  47 #define CONVERT_O       (1.0 / 64)
  48 #define CONVERT_O_A     (CONVERT_O)
  49 #define CONVERT_O_P     (CONVERT_O)
  50 #define CONVERT_O_R     (-CONVERT_O)
  51
  52 /* Conversion of gyro data to SI units (radian/sec) */
  53 #define CONVERT_GYRO    (2000.0 / 32767 * M_PI / 180)
  54 #define CONVERT_GYRO_X  (-CONVERT_GYRO)
  55 #define CONVERT_GYRO_Y  (-CONVERT_GYRO)
  56 #define CONVERT_GYRO_Z  (CONVERT_GYRO)
  57
  58 #define BIT(x) (1 << (x))
  59
  60 inline unsigned int set_bit_range (int start, int end)
  61 {
  62         int i;
  63         unsigned int value = 0;
  64
  65         for (i = start; i < end; ++i)
  66                 value |= BIT(i);
  67
  68         return value;
  69 }
  70
  71 inline float convert_from_vtf_format (int size, int exponent, unsigned int value)
  72 {
  73         int divider = 1;
  74         int i;
  75         float sample;
  76         float mul = 1.0;
  77
  78         value = value & set_bit_range(0, size * 8);
  79
  80         if (value & BIT(size*8-1)) {
  81                 value =  ((1LL << (size * 8)) - value);
  82                 mul = -1.0;
  83         }
  84
  85         sample = value * 1.0;
  86
  87         if (exponent < 0) {
  88                 exponent = abs(exponent);
  89                 for (i = 0; i < exponent; ++i)
  90                         divider = divider * 10;
  91
  92                 return mul * sample/divider;
  93         }
  94
  95         return mul * sample * pow(10.0, exponent);
  96 }
  97
  98 /* Platform sensor orientation */
  99 #define DEF_ORIENT_ACCEL_X      -1
 100 #define DEF_ORIENT_ACCEL_Y      -1
 101 #define DEF_ORIENT_ACCEL_Z      -1
 102
 103 #define DEF_ORIENT_GYRO_X       1
 104 #define DEF_ORIENT_GYRO_Y       1
 105 #define DEF_ORIENT_GYRO_Z       1
 106
 107 /* G to m/s^2 */
 108 #define CONVERT_FROM_VTF16(s,d,x)      convert_from_vtf_format(s,d,x)
 109 #define CONVERT_A_G_VTF16E14_X(s,d,x)  (DEF_ORIENT_ACCEL_X * convert_from_vtf_format(s,d,x) * GRAVITY)
 110 #define CONVERT_A_G_VTF16E14_Y(s,d,x)  (DEF_ORIENT_ACCEL_Y * convert_from_vtf_format(s,d,x) * GRAVITY)
 111 #define CONVERT_A_G_VTF16E14_Z(s,d,x)  (DEF_ORIENT_ACCEL_Z * convert_from_vtf_format(s,d,x) * GRAVITY)
 112
 113 /* Degree/sec to radian/sec */
 114 #define CONVERT_G_D_VTF16E14_X(s,d,x)  (DEF_ORIENT_GYRO_X * convert_from_vtf_format(s,d,x) * M_PI / 180)
 115 #define CONVERT_G_D_VTF16E14_Y(s,d,x)  (DEF_ORIENT_GYRO_Y * convert_from_vtf_format(s,d,x) * M_PI / 180)
 116 #define CONVERT_G_D_VTF16E14_Z(s,d,x)  (DEF_ORIENT_GYRO_Z * convert_from_vtf_format(s,d,x) * M_PI / 180)
 117
 118 /* Milli gauss to micro tesla */
 119 #define CONVERT_M_MG_VTF16E14_X(s,d,x) (convert_from_vtf_format(s,d,x) / 10)
 120 #define CONVERT_M_MG_VTF16E14_Y(s,d,x) (convert_from_vtf_format(s,d,x) / 10)
 121 #define CONVERT_M_MG_VTF16E14_Z(s,d,x) (convert_from_vtf_format(s,d,x) / 10)
 122
 123
 124 static int64_t sample_as_int64 (unsigned char* sample, datum_info_t* type)
 125 {
 126         uint64_t u64;
 127         int i;
 128         int zeroed_bits = type->storagebits - type->realbits;
 129         uint64_t sign_mask;
 130         uint64_t value_mask;
 131
 132         u64 = 0;
 133
 134         if (type->endianness == 'b')
 135                 for (i=0; i<type->storagebits/8; i++)
 136                         u64 = (u64 << 8) | sample[i];
 137         else
 138                 for (i=type->storagebits/8 - 1; i>=0; i--)
 139                         u64 = (u64 << 8) | sample[i];
 140
 141         u64 = (u64 >> type->shift) & (~0ULL >> zeroed_bits);
 142
 143         if (type->sign == 'u')
 144                 return (int64_t) u64; /* We don't handle unsigned 64 bits int */
 145
 146         /* Signed integer */
 147
 148         switch (type->realbits) {
 149                 case 0 ... 1:
 150                         return 0;
 151
 152                 case 8:
 153                         return (int64_t) (int8_t) u64;
 154
 155                 case 16:
 156                         return (int64_t) (int16_t) u64;
 157
 158                 case 32:
 159                         return (int64_t) (int32_t) u64;
 160
 161                 case 64:
 162                         return (int64_t) u64;
 163
 164                 default:
 165                         sign_mask = 1 << (type->realbits-1);
 166                         value_mask = sign_mask - 1;
 167
 168                         if (u64 & sign_mask)
 169                                 return - ((~u64 & value_mask) + 1);     /* Negative value: return 2-complement */
 170                         else
 171                                 return (int64_t) u64;                   /* Positive value */
 172         }
 173 }
 174
 175
 176 static void reorder_fields (float* data, unsigned char map[MAX_CHANNELS])
 177 {
 178         int i;
 179         float temp[MAX_CHANNELS];
 180
 181         for (i=0; i<MAX_CHANNELS; i++)
 182                 temp[i] = data[map[i]];
 183
 184         for (i=0; i<MAX_CHANNELS; i++)
 185                 data[i] = temp[i];
 186 }
 187
 188
 189 static void clamp_gyro_readings_to_zero (int s, sensors_event_t* data)
 190 {
 191         float x, y, z;
 192         float near_zero;
 193
 194         x = data->data[0];
 195         y = data->data[1];
 196         z = data->data[2];
 197
 198         /* If we're calibrated, don't filter out as much */
 199         if (sensor[s].cal_level > 0)
 200                 near_zero = 0.02; /* rad/s */
 201         else
 202                 near_zero = 0.1;
 203
 204         /* If motion on all axes is small enough */
 205         if (fabs(x) < near_zero && fabs(y) < near_zero && fabs(z) < near_zero) {
 206
 207                 /*
 208                  * Report that we're not moving at all... but not exactly zero as composite sensors (orientation, rotation vector) don't
 209                  * seem to react very well to it.
 210                  */
 211
 212                 data->data[0] *= 0.000001;
 213                 data->data[1] *= 0.000001;
 214                 data->data[2] *= 0.000001;
 215         }
 216 }
 217
 218
 219 static void process_event_gyro_uncal (int s, int i, sensors_event_t* data)
 220 {
 221         gyro_cal_t* gyro_data;
 222
 223         if (sensor[s].type == SENSOR_TYPE_GYROSCOPE) {
 224                 gyro_data = (gyro_cal_t*) sensor[s].cal_data;
 225
 226                 memcpy(&sensor[i].sample, data, sizeof(sensors_event_t));
 227
 228                 sensor[i].sample.type = SENSOR_TYPE_GYROSCOPE_UNCALIBRATED;
 229                 sensor[i].sample.sensor = s;
 230
 231                 sensor[i].sample.data[0] = data->data[0] + gyro_data->bias_x;
 232                 sensor[i].sample.data[1] = data->data[1] + gyro_data->bias_y;
 233                 sensor[i].sample.data[2] = data->data[2] + gyro_data->bias_z;
 234
 235                 sensor[i].sample.uncalibrated_gyro.bias[0] = gyro_data->bias_x;
 236                 sensor[i].sample.uncalibrated_gyro.bias[1] = gyro_data->bias_y;
 237                 sensor[i].sample.uncalibrated_gyro.bias[2] = gyro_data->bias_z;
 238
 239                 sensor[i].report_pending = 1;
 240         }
 241 }
 242
 243
 244 static void process_event (int s, sensors_event_t* data)
 245 {
 246         /*
 247          * This gets the real event (post process - calibration, filtering & co.) and makes it into a virtual one.
 248          * The specific processing function for each sensor will populate the necessary fields and set up the report pending flag.
 249          */
 250
 251          int i;
 252
 253          /* Go through out virtual sensors and check if we can use this event */
 254          for (i = 0; i < sensor_count; i++)
 255                 switch (sensor[i].type) {
 256                         case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
 257                                 process_event_gyro_uncal(s, i, data);
 258                                 break;
 259
 260                         default:
 261                                 break;
 262                 }
 263 }
 264
 265
 266 static int finalize_sample_default (int s, sensors_event_t* data)
 267 {
 268         /* Swap fields if we have a custom channel ordering on this sensor */
 269         if (sensor[s].quirks & QUIRK_FIELD_ORDERING)
 270                 reorder_fields(data->data, sensor[s].order);
 271
 272         sensor[s].event_count++;
 273         switch (sensor[s].type) {
 274                 case SENSOR_TYPE_ACCELEROMETER:
 275                         /* Always consider the accelerometer accurate */
 276                         data->acceleration.status = SENSOR_STATUS_ACCURACY_HIGH;
 277                         if (sensor[s].quirks & QUIRK_NOISY)
 278                                 denoise(s, data);
 279                         break;
 280
 281                 case SENSOR_TYPE_MAGNETIC_FIELD:
 282                         calibrate_compass (data, &sensor[s]);
 283                         if (sensor[s].quirks & QUIRK_NOISY)
 284                                 denoise(s, data);
 285                         break;
 286
 287                 case SENSOR_TYPE_GYROSCOPE:
 288
 289                         /* Report medium accuracy by default ; higher accuracy levels will be reported once, and if, we achieve  calibration. */
 290                         data->gyro.status = SENSOR_STATUS_ACCURACY_MEDIUM;
 291
 292                         /*
 293                          * We're only trying to calibrate data from continuously firing gyroscope drivers, as motion based ones use
 294                          * movement thresholds that may lead us to incorrectly estimate bias.
 295                          */
 296                         if (sensor[s].selected_trigger !=
 297                                 sensor[s].motion_trigger_name)
 298                                         calibrate_gyro(data, &sensor[s]);
 299
 300                         /*
 301                          * For noisy sensors drop a few samples to make sure we have at least GYRO_MIN_SAMPLES events in the
 302                          * filtering queue. This improves mean and std dev.
 303                          */
 304                         if (sensor[s].quirks & QUIRK_NOISY) {
 305                                 if (sensor[s].selected_trigger !=
 306                                     sensor[s].motion_trigger_name &&
 307                                     sensor[s].event_count < GYRO_MIN_SAMPLES)
 308                                                 return 0;
 309
 310                                 denoise(s, data);
 311                         }
 312
 313                         /* Clamp near zero moves to (0,0,0) if appropriate */
 314                         clamp_gyro_readings_to_zero(s, data);
 315                         break;
 316
 317                 case SENSOR_TYPE_LIGHT:
 318                 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
 319                 case SENSOR_TYPE_TEMPERATURE:
 320                         /* Only keep two decimals for these readings */
 321                         data->data[0] = 0.01 * ((int) (data->data[0] * 100));
 322
 323                         /* ... fall through ... */
 324
 325                 case SENSOR_TYPE_PROXIMITY:
 326                         /* These are on change sensors ; drop the sample if it has the same value as the previously reported one. */
 327                         if (data->data[0] == sensor[s].prev_val)
 328                                 return 0;
 329
 330                         sensor[s].prev_val = data->data[0];
 331                         break;
 332         }
 333
 334         /* If there are active virtual sensors depending on this one - process the event */
 335         if (sensor[s].ref_count)
 336                 process_event(s, data);
 337
 338         /* We will drop samples if the sensor is not directly enabled */
 339         if (!sensor[s].directly_enabled)
 340                 return 0;
 341
 342         return 1; /* Return sample to Android */
 343 }
 344
 345
 346 static float transform_sample_default (int s, int c, unsigned char* sample_data)
 347 {
 348         datum_info_t* sample_type = &sensor[s].channel[c].type_info;
 349         int64_t s64 = sample_as_int64(sample_data, sample_type);
 350         float scale = sensor[s].scale ? sensor[s].scale : sensor[s].channel[c].scale;
 351
 352         /* In case correction has been requested using properties, apply it */
 353         scale *= sensor[s].channel[c].opt_scale;
 354
 355         /* Apply default scaling rules */
 356         return (sensor[s].offset + s64) * scale;
 357 }
 358
 359
 360 static int finalize_sample_ISH (int s, sensors_event_t* data)
 361 {
 362         float pitch, roll, yaw;
 363
 364         /* Swap fields if we have a custom channel ordering on this sensor */
 365         if (sensor[s].quirks & QUIRK_FIELD_ORDERING)
 366                 reorder_fields(data->data, sensor[s].order);
 367
 368         if (sensor[s].type == SENSOR_TYPE_ORIENTATION) {
 369
 370                 pitch = data->data[0];
 371                 roll = data->data[1];
 372                 yaw = data->data[2];
 373
 374                 data->data[0] = 360.0 - yaw;
 375                 data->data[1] = -pitch;
 376                 data->data[2] = -roll;
 377         }
 378
 379         /* Add this event to our global records, for filtering purposes */
 380         record_sample(s, data);
 381
 382         return 1; /* Return sample to Android */
 383 }
 384
 385
 386 static float transform_sample_ISH (int s, int c, unsigned char* sample_data)
 387 {
 388         datum_info_t* sample_type = &sensor[s].channel[c].type_info;
 389         int val         = (int) sample_as_int64(sample_data, sample_type);
 390         float correction;
 391         int data_bytes  = (sample_type->realbits)/8;
 392         int exponent    = sensor[s].offset;
 393
 394         /* In case correction has been requested using properties, apply it */
 395         correction = sensor[s].channel[c].opt_scale;
 396
 397         switch (sensor[s].type) {
 398                 case SENSOR_TYPE_ACCELEROMETER:
 399                         switch (c) {
 400                                 case 0:
 401                                         return correction * CONVERT_A_G_VTF16E14_X(data_bytes, exponent, val);
 402
 403                                 case 1:
 404                                         return correction * CONVERT_A_G_VTF16E14_Y(data_bytes, exponent, val);
 405
 406                                 case 2:
 407                                         return  correction * CONVERT_A_G_VTF16E14_Z(data_bytes, exponent, val);
 408                         }
 409                         break;
 410
 411                 case SENSOR_TYPE_GYROSCOPE:
 412                         switch (c) {
 413                                 case 0:
 414                                         return correction * CONVERT_G_D_VTF16E14_X(data_bytes, exponent, val);
 415
 416                                 case 1:
 417                                         return correction * CONVERT_G_D_VTF16E14_Y(data_bytes, exponent, val);
 418
 419                                 case 2:
 420                                         return  correction * CONVERT_G_D_VTF16E14_Z(data_bytes, exponent, val);
 421                         }
 422                         break;
 423
 424                 case SENSOR_TYPE_MAGNETIC_FIELD:
 425                         switch (c) {
 426                                 case 0:
 427                                         return correction * CONVERT_M_MG_VTF16E14_X(data_bytes, exponent, val);
 428
 429                                 case 1:
 430                                         return correction * CONVERT_M_MG_VTF16E14_Y(data_bytes, exponent, val);
 431
 432                                 case 2:
 433                                         return correction * CONVERT_M_MG_VTF16E14_Z(data_bytes, exponent, val);
 434                         }
 435                         break;
 436
 437                 case SENSOR_TYPE_LIGHT:
 438                         return (float) val;
 439
 440                 case SENSOR_TYPE_ORIENTATION:
 441                         return correction * convert_from_vtf_format(data_bytes, exponent, val);
 442
 443                 case SENSOR_TYPE_ROTATION_VECTOR:
 444                         return correction * convert_from_vtf_format(data_bytes, exponent, val);
 445         }
 446
 447         return 0;
 448 }
 449
 450
 451 void select_transform (int s)
 452 {
 453         char prop_name[PROP_NAME_MAX];
 454         char prop_val[PROP_VALUE_MAX];
 455         int i                   = sensor[s].catalog_index;
 456         const char *prefix      = sensor_catalog[i].tag;
 457
 458         sprintf(prop_name, PROP_BASE, prefix, "transform");
 459
 460         if (property_get(prop_name, prop_val, ""))
 461                 if (!strcmp(prop_val, "ISH")) {
 462                         ALOGI(  "Using Intel Sensor Hub semantics on %s\n", sensor[s].friendly_name);
 463
 464                         sensor[s].ops.transform = transform_sample_ISH;
 465                         sensor[s].ops.finalize = finalize_sample_ISH;
 466                         return;
 467                 }
 468
 469         sensor[s].ops.transform = transform_sample_default;
 470         sensor[s].ops.finalize = finalize_sample_default;
 471 }
 472
 473
 474 float acquire_immediate_value (int s, int c)
 475 {
 476         char sysfs_path[PATH_MAX];
 477         float val;
 478         int ret;
 479         int dev_num = sensor[s].dev_num;
 480         int i = sensor[s].catalog_index;
 481         const char* raw_path = sensor_catalog[i].channel[c].raw_path;
 482         const char* input_path = sensor_catalog[i].channel[c].input_path;
 483         float scale = sensor[s].scale ? sensor[s].scale : sensor[s].channel[c].scale;
 484         float offset = sensor[s].offset;
 485         int sensor_type = sensor_catalog[i].type;
 486         float correction;
 487
 488         /* In case correction has been requested using properties, apply it */
 489         correction = sensor[s].channel[c].opt_scale;
 490
 491         /* Acquire a sample value for sensor s / channel c through sysfs */
 492
 493         if (input_path[0]) {
 494                 sprintf(sysfs_path, BASE_PATH "%s", dev_num, input_path);
 495                 ret = sysfs_read_float(sysfs_path, &val);
 496
 497                 if (!ret)
 498                         return val * correction;
 499         };
 500
 501         if (!raw_path[0])
 502                 return 0;
 503
 504         sprintf(sysfs_path, BASE_PATH "%s", dev_num, raw_path);
 505         ret = sysfs_read_float(sysfs_path, &val);
 506
 507         if (ret == -1)
 508                 return 0;
 509
 510         /*
 511          * There is no transform ops defined yet for raw sysfs values.
 512          * Use this function to perform transformation as well.
 513          */
 514         if (sensor_type == SENSOR_TYPE_MAGNETIC_FIELD)
 515                 return CONVERT_GAUSS_TO_MICROTESLA ((val + offset) * scale) * correction;
 516
 517         return (val + offset) * scale * correction;
 518 }