// -*- tab-width: 4; Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- /* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ // // // total up and check overflow // check size of group var_info /// @file AP_Param.cpp /// @brief The AP variable store. #include "AP_Param.h" #include #include #include #include #include #include #include extern const AP_HAL::HAL &hal; #define ENABLE_DEBUG 1 #if ENABLE_DEBUG # define Debug(fmt, args ...) do {hal.console->printf("%s:%d: " fmt "\n", __FUNCTION__, __LINE__, ## args); } while(0) #else # define Debug(fmt, args ...) #endif // the 'GROUP_ID' of a element of a group is the 18 bit identifier // used to distinguish between this element of the group and other // elements of the same group. It is calculated using a bit shift per // level of nesting, so the first level of nesting gets 6 bits the 2nd // level gets the next 6 bits, and the 3rd level gets the last 6 // bits. This limits groups to having at most 64 elements. #define GROUP_ID(grpinfo, base, i, shift) ((base)+((grpinfo[i].idx)<<(shift))) // Note about AP_Vector3f handling. // The code has special cases for AP_Vector3f to allow it to be viewed // as both a single 3 element vector and as a set of 3 AP_Float // variables. This is done to make it possible for MAVLink to see // vectors as parameters, which allows users to save their compass // offsets in MAVLink parameter files. The code involves quite a few // special cases which could be generalised to any vector/matrix type // if we end up needing this behaviour for other than AP_Vector3f // static member variables for AP_Param. // // number of rows in the _var_info[] table uint16_t AP_Param::_num_vars; // storage and naming information about all types that can be saved const AP_Param::Info *AP_Param::_var_info; struct AP_Param::param_override *AP_Param::param_overrides = NULL; uint16_t AP_Param::num_param_overrides = 0; // storage object StorageAccess AP_Param::_storage(StorageManager::StorageParam); // write to EEPROM void AP_Param::eeprom_write_check(const void *ptr, uint16_t ofs, uint8_t size) { _storage.write_block(ofs, ptr, size); } // write a sentinal value at the given offset void AP_Param::write_sentinal(uint16_t ofs) { struct Param_header phdr; phdr.type = _sentinal_type; set_key(phdr, _sentinal_key); phdr.group_element = _sentinal_group; eeprom_write_check(&phdr, ofs, sizeof(phdr)); } // erase all EEPROM variables by re-writing the header and adding // a sentinal void AP_Param::erase_all(void) { struct EEPROM_header hdr; // write the header hdr.magic[0] = k_EEPROM_magic0; hdr.magic[1] = k_EEPROM_magic1; hdr.revision = k_EEPROM_revision; hdr.spare = 0; eeprom_write_check(&hdr, 0, sizeof(hdr)); // add a sentinal directly after the header write_sentinal(sizeof(struct EEPROM_header)); } // validate a group info table bool AP_Param::check_group_info(const struct AP_Param::GroupInfo * group_info, uint16_t * total_size, uint8_t group_shift, uint8_t prefix_length) { uint8_t type; uint64_t used_mask = 0; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { uint8_t idx = group_info[i].idx; if (idx >= (1<<_group_level_shift)) { Debug("idx too large (%u) in %s", idx, group_info[i].name); return false; } if (type == AP_PARAM_GROUP) { // a nested group const struct GroupInfo *ginfo = group_info[i].group_info; if (group_shift + _group_level_shift >= _group_bits) { Debug("double group nesting in %s", group_info[i].name); return false; } if (ginfo == NULL || !check_group_info(ginfo, total_size, group_shift + _group_level_shift, prefix_length + strlen(group_info[i].name))) { return false; } continue; } if (used_mask & (1ULL< 16) { Debug("suffix is too long in %s", group_info[i].name); return false; } (*total_size) += size + sizeof(struct Param_header); } return true; } // check for duplicate key values bool AP_Param::duplicate_key(uint16_t vindex, uint16_t key) { for (uint16_t i=vindex+1; i<_num_vars; i++) { uint16_t key2 = _var_info[i].key; if (key2 == key) { // no duplicate keys allowed return true; } } return false; } // validate the _var_info[] table bool AP_Param::check_var_info(void) { uint16_t total_size = sizeof(struct EEPROM_header); for (uint16_t i=0; i<_num_vars; i++) { uint8_t type = _var_info[i].type; uint16_t key = _var_info[i].key; if (type == AP_PARAM_GROUP) { if (i == 0) { // first element can't be a group, for first() call return false; } const struct GroupInfo *group_info = _var_info[i].group_info; if (group_info == NULL || !check_group_info(group_info, &total_size, 0, strlen(_var_info[i].name))) { return false; } } else { uint8_t size = type_size((enum ap_var_type)type); if (size == 0) { // not a valid type - the top level list can't contain // AP_PARAM_NONE return false; } total_size += size + sizeof(struct Param_header); } if (duplicate_key(i, key)) { return false; } } // we no longer check if total_size is larger than _eeprom_size, // as we allow for more variables than could fit, relying on not // saving default values return true; } // setup the _var_info[] table bool AP_Param::setup(void) { struct EEPROM_header hdr; // check the header _storage.read_block(&hdr, 0, sizeof(hdr)); if (hdr.magic[0] != k_EEPROM_magic0 || hdr.magic[1] != k_EEPROM_magic1 || hdr.revision != k_EEPROM_revision) { // header doesn't match. We can't recover any variables. Wipe // the header and setup the sentinal directly after the header Debug("bad header in setup - erasing"); erase_all(); } return true; } // check if AP_Param has been initialised bool AP_Param::initialised(void) { return _var_info != NULL; } /* adjust offset of a group element for nested groups and group pointers The new_offset variable is relative to the vindex base. This makes dealing with pointer groups tricky */ bool AP_Param::adjust_group_offset(uint16_t vindex, const struct GroupInfo &group_info, ptrdiff_t &new_offset) { if (group_info.flags & AP_PARAM_FLAG_NESTED_OFFSET) { new_offset += group_info.offset; return true; } if (group_info.flags & AP_PARAM_FLAG_POINTER) { // group_info.offset refers to a pointer void **p = (void **)(((ptrdiff_t)_var_info[vindex].ptr) + new_offset + group_info.offset); if (*p == nullptr) { // the object is not allocated yet return false; } // calculate offset that is needed to take base object and adjust for this object new_offset = ((ptrdiff_t)*p) - (ptrdiff_t)_var_info[vindex].ptr; } return true; } // find the info structure given a header and a group_info table // return the Info structure and a pointer to the variables storage const struct AP_Param::Info *AP_Param::find_by_header_group(struct Param_header phdr, void **ptr, uint16_t vindex, const struct GroupInfo *group_info, uint8_t group_base, uint8_t group_shift, ptrdiff_t group_offset) { uint8_t type; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { if (type == AP_PARAM_GROUP) { // a nested group if (group_shift + _group_level_shift >= _group_bits) { // too deeply nested - this should have been caught by // setup() ! return NULL; } const struct GroupInfo *ginfo = group_info[i].group_info; ptrdiff_t new_offset = group_offset; if (!adjust_group_offset(vindex, group_info[i], new_offset)) { continue; } const struct AP_Param::Info *ret = find_by_header_group(phdr, ptr, vindex, ginfo, GROUP_ID(group_info, group_base, i, group_shift), group_shift + _group_level_shift, new_offset); if (ret != NULL) { return ret; } continue; } if (GROUP_ID(group_info, group_base, i, group_shift) == phdr.group_element && type == phdr.type) { // found a group element *ptr = (void*)((ptrdiff_t)_var_info[vindex].ptr + group_info[i].offset + group_offset); return &_var_info[vindex]; } } return NULL; } // find the info structure given a header // return the Info structure and a pointer to the variables storage const struct AP_Param::Info *AP_Param::find_by_header(struct Param_header phdr, void **ptr) { // loop over all named variables for (uint16_t i=0; i<_num_vars; i++) { uint8_t type = _var_info[i].type; uint16_t key = _var_info[i].key; if (key != get_key(phdr)) { // not the right key continue; } if (type == AP_PARAM_GROUP) { const struct GroupInfo *group_info = _var_info[i].group_info; return find_by_header_group(phdr, ptr, i, group_info, 0, 0, 0); } if (type == phdr.type) { // found it *ptr = (void*)_var_info[i].ptr; return &_var_info[i]; } } return NULL; } // find the info structure for a variable in a group const struct AP_Param::Info *AP_Param::find_var_info_group(const struct GroupInfo * group_info, uint16_t vindex, uint8_t group_base, uint8_t group_shift, ptrdiff_t group_offset, uint32_t * group_element, const struct GroupInfo * &group_ret, const struct GroupInfo * &group_ret0, uint8_t * idx) const { ptrdiff_t base = (ptrdiff_t)_var_info[vindex].ptr; uint8_t type; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { ptrdiff_t ofs = group_info[i].offset + group_offset; if (type == AP_PARAM_GROUP) { const struct GroupInfo *ginfo = group_info[i].group_info; // a nested group if (group_shift + _group_level_shift >= _group_bits) { // too deeply nested - this should have been caught by // setup() ! return NULL; } const struct AP_Param::Info *info; ptrdiff_t new_offset = group_offset; if (!adjust_group_offset(vindex, group_info[i], new_offset)) { continue; } info = find_var_info_group(ginfo, vindex, GROUP_ID(group_info, group_base, i, group_shift), group_shift + _group_level_shift, new_offset, group_element, group_ret, group_ret0, idx); if (info != NULL) { group_ret0 = &group_info[i]; return info; } } else if ((ptrdiff_t) this == base + ofs) { *group_element = GROUP_ID(group_info, group_base, i, group_shift); group_ret = &group_info[i]; *idx = 0; return &_var_info[vindex]; } else if (type == AP_PARAM_VECTOR3F && (base+ofs+(ptrdiff_t)sizeof(float) == (ptrdiff_t) this || base+ofs+2*(ptrdiff_t)sizeof(float) == (ptrdiff_t) this)) { // we are inside a Vector3f. We need to work out which // element of the vector the current object refers to. *idx = (((ptrdiff_t) this) - (base+ofs))/sizeof(float); *group_element = GROUP_ID(group_info, group_base, i, group_shift); group_ret = &group_info[i]; return &_var_info[vindex]; } } return NULL; } // find the info structure for a variable const struct AP_Param::Info *AP_Param::find_var_info(uint32_t * group_element, const struct GroupInfo * &group_ret, const struct GroupInfo * &group_ret0, uint8_t * idx) const { group_ret0 = group_ret = NULL; for (uint16_t i=0; i<_num_vars; i++) { uint8_t type = _var_info[i].type; ptrdiff_t base = (ptrdiff_t)_var_info[i].ptr; if (type == AP_PARAM_GROUP) { const struct GroupInfo *group_info = _var_info[i].group_info; const struct AP_Param::Info *info; info = find_var_info_group(group_info, i, 0, 0, 0, group_element, group_ret, group_ret0, idx); if (info != NULL) { return info; } } else if (base == (ptrdiff_t) this) { *group_element = 0; *idx = 0; return &_var_info[i]; } else if (type == AP_PARAM_VECTOR3F && (base+(ptrdiff_t)sizeof(float) == (ptrdiff_t) this || base+2*(ptrdiff_t)sizeof(float) == (ptrdiff_t) this)) { // we are inside a Vector3f. Work out which element we are // referring to. *idx = (((ptrdiff_t) this) - base)/sizeof(float); *group_element = 0; return &_var_info[i]; } } return NULL; } // find the info structure for a variable const struct AP_Param::Info *AP_Param::find_var_info_token(const ParamToken &token, uint32_t * group_element, const struct GroupInfo * &group_ret, const struct GroupInfo * &group_ret0, uint8_t * idx) const { uint16_t i = token.key; uint8_t type = _var_info[i].type; ptrdiff_t base = (ptrdiff_t)_var_info[i].ptr; group_ret0 = group_ret = NULL; if (type == AP_PARAM_GROUP) { const struct GroupInfo *group_info = _var_info[i].group_info; const struct AP_Param::Info *info; info = find_var_info_group(group_info, i, 0, 0, 0, group_element, group_ret, group_ret0, idx); if (info != NULL) { return info; } } else if (base == (ptrdiff_t) this) { *group_element = 0; *idx = 0; return &_var_info[i]; } else if (type == AP_PARAM_VECTOR3F && (base+(ptrdiff_t)sizeof(float) == (ptrdiff_t) this || base+2*(ptrdiff_t)sizeof(float) == (ptrdiff_t) this)) { // we are inside a Vector3f. Work out which element we are // referring to. *idx = (((ptrdiff_t) this) - base)/sizeof(float); *group_element = 0; return &_var_info[i]; } return NULL; } // return the storage size for a AP_PARAM_* type uint8_t AP_Param::type_size(enum ap_var_type type) { switch (type) { case AP_PARAM_NONE: case AP_PARAM_GROUP: return 0; case AP_PARAM_INT8: return 1; case AP_PARAM_INT16: return 2; case AP_PARAM_INT32: return 4; case AP_PARAM_FLOAT: return 4; case AP_PARAM_VECTOR3F: return 3*4; } Debug("unknown type %u\n", type); return 0; } /* extract 9 bit key from Param_header */ uint16_t AP_Param::get_key(const Param_header &phdr) { return ((uint16_t)phdr.key_high)<<8 | phdr.key_low; } /* set 9 bit key in Param_header */ void AP_Param::set_key(Param_header &phdr, uint16_t key) { phdr.key_low = key & 0xFF; phdr.key_high = key >> 8; } /* return true if a header is the end of eeprom sentinal */ bool AP_Param::is_sentinal(const Param_header &phdr) { // note that this is an ||, not an &&, as this makes us more // robust to power off while adding a variable to EEPROM if (phdr.type == _sentinal_type || get_key(phdr) == _sentinal_key || phdr.group_element == _sentinal_group) { return true; } return false; } // scan the EEPROM looking for a given variable by header content // return true if found, along with the offset in the EEPROM where // the variable is stored // if not found return the offset of the sentinal // if the sentinal isn't found either, the offset is set to 0xFFFF bool AP_Param::scan(const AP_Param::Param_header *target, uint16_t *pofs) { struct Param_header phdr; uint16_t ofs = sizeof(AP_Param::EEPROM_header); while (ofs < _storage.size()) { _storage.read_block(&phdr, ofs, sizeof(phdr)); if (phdr.type == target->type && get_key(phdr) == get_key(*target) && phdr.group_element == target->group_element) { // found it *pofs = ofs; return true; } if (is_sentinal(phdr)) { // we've reached the sentinal *pofs = ofs; return false; } ofs += type_size((enum ap_var_type)phdr.type) + sizeof(phdr); } *pofs = 0xffff; Debug("scan past end of eeprom"); return false; } /** * add a _X, _Y, _Z suffix to the name of a Vector3f element * @param buffer * @param buffer_size * @param idx Suffix: 0 --> _X; 1 --> _Y; 2 --> _Z; (other --> undefined) */ void AP_Param::add_vector3f_suffix(char *buffer, size_t buffer_size, uint8_t idx) const { const size_t len = strnlen(buffer, buffer_size); if (len + 2 <= buffer_size) { buffer[len] = '_'; buffer[len + 1] = static_cast('X' + idx); if (len + 3 <= buffer_size) { buffer[len + 2] = 0; } } } // Copy the variable's whole name to the supplied buffer. // // If the variable is a group member, prepend the group name. // void AP_Param::copy_name_token(const ParamToken &token, char *buffer, size_t buffer_size, bool force_scalar) const { uint32_t group_element; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info_token(token, &group_element, ginfo, ginfo0, &idx); if (info == NULL) { *buffer = 0; Debug("no info found"); return; } copy_name_info(info, ginfo, ginfo0, idx, buffer, buffer_size, force_scalar); } void AP_Param::copy_name_info(const struct AP_Param::Info *info, const struct GroupInfo *ginfo, const struct GroupInfo *ginfo0, uint8_t idx, char *buffer, size_t buffer_size, bool force_scalar) const { strncpy(buffer, info->name, buffer_size); if (ginfo0 != NULL) { uint8_t len = strnlen(buffer, buffer_size); if (len < buffer_size) { strncpy(&buffer[len], ginfo0->name, buffer_size-len); } } if (ginfo != NULL) { uint8_t len = strnlen(buffer, buffer_size); if (len < buffer_size) { strncpy(&buffer[len], ginfo->name, buffer_size-len); } if ((force_scalar || idx != 0) && AP_PARAM_VECTOR3F == ginfo->type) { // the caller wants a specific element in a Vector3f add_vector3f_suffix(buffer, buffer_size, idx); } } else if ((force_scalar || idx != 0) && AP_PARAM_VECTOR3F == info->type) { add_vector3f_suffix(buffer, buffer_size, idx); } } // Find a variable by name in a group AP_Param * AP_Param::find_group(const char *name, uint16_t vindex, ptrdiff_t group_offset, const struct GroupInfo *group_info, enum ap_var_type *ptype) { uint8_t type; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { if (type == AP_PARAM_GROUP) { if (strncasecmp(name, group_info[i].name, strlen(group_info[i].name)) != 0) { continue; } const struct GroupInfo *ginfo = group_info[i].group_info; ptrdiff_t new_offset = group_offset; if (!adjust_group_offset(vindex, group_info[i], new_offset)) { continue; } AP_Param *ap = find_group(name+strlen(group_info[i].name), vindex, new_offset, ginfo, ptype); if (ap != NULL) { return ap; } } else if (strcasecmp(name, group_info[i].name) == 0) { ptrdiff_t p = (ptrdiff_t)_var_info[vindex].ptr; *ptype = (enum ap_var_type)type; return (AP_Param *)(p + group_info[i].offset + group_offset); } else if (type == AP_PARAM_VECTOR3F) { // special case for finding Vector3f elements uint8_t suffix_len = strnlen(group_info[i].name, AP_MAX_NAME_SIZE); if (strncmp(name, group_info[i].name, suffix_len) == 0 && name[suffix_len] == '_' && (name[suffix_len+1] == 'X' || name[suffix_len+1] == 'Y' || name[suffix_len+1] == 'Z')) { ptrdiff_t p = (ptrdiff_t)_var_info[vindex].ptr; AP_Float *v = (AP_Float *)(p + group_info[i].offset + group_offset); *ptype = AP_PARAM_FLOAT; switch (name[suffix_len+1]) { case 'X': return (AP_Float *)&v[0]; case 'Y': return (AP_Float *)&v[1]; case 'Z': return (AP_Float *)&v[2]; } } } } return NULL; } // Find a variable by name. // AP_Param * AP_Param::find(const char *name, enum ap_var_type *ptype) { for (uint16_t i=0; i<_num_vars; i++) { uint8_t type = _var_info[i].type; if (type == AP_PARAM_GROUP) { uint8_t len = strnlen(_var_info[i].name, AP_MAX_NAME_SIZE); if (strncmp(name, _var_info[i].name, len) != 0) { continue; } const struct GroupInfo *group_info = _var_info[i].group_info; AP_Param *ap = find_group(name + len, i, 0, group_info, ptype); if (ap != NULL) { return ap; } // we continue looking as we want to allow top level // parameter to have the same prefix name as group // parameters, for example CAM_P_G } else if (strcasecmp(name, _var_info[i].name) == 0) { *ptype = (enum ap_var_type)type; return (AP_Param *)_var_info[i].ptr; } } return NULL; } /* find the def_value for a variable by name */ const float * AP_Param::find_def_value_ptr(const char *name) { enum ap_var_type ptype; AP_Param *vp = find(name, &ptype); if (vp == NULL) { return NULL; } uint32_t group_element; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t gidx; const struct AP_Param::Info *info = vp->find_var_info(&group_element, ginfo, ginfo0, &gidx); if (info == NULL) { return NULL; } if (ginfo != NULL) { return &ginfo->def_value; } return &info->def_value; } // Find a variable by index. Note that this is quite slow. // AP_Param * AP_Param::find_by_index(uint16_t idx, enum ap_var_type *ptype, ParamToken *token) { AP_Param *ap; uint16_t count=0; for (ap=AP_Param::first(token, ptype); ap && count < idx; ap=AP_Param::next_scalar(token, ptype)) { count++; } return ap; } /* Find a variable by pointer, returning a ParamToken */ bool AP_Param::find_by_pointer(AP_Param *p, ParamToken &token) { AP_Param *ap; enum ap_var_type ptype; for (ap=AP_Param::first(&token, &ptype); ap && ap != p; ap=AP_Param::next(&token, &ptype)) { } return ap == p; } // Find a object by name. // AP_Param * AP_Param::find_object(const char *name) { for (uint16_t i=0; i<_num_vars; i++) { if (strcasecmp(name, _var_info[i].name) == 0) { return (AP_Param *)_var_info[i].ptr; } } return NULL; } // notify GCS of current value of parameter void AP_Param::notify() const { uint32_t group_element = 0; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info(&group_element, ginfo, ginfo0, &idx); if (info == NULL) { // this is probably very bad return; } char name[AP_MAX_NAME_SIZE+1]; copy_name_info(info, ginfo, ginfo0, idx, name, sizeof(name), true); uint32_t param_header_type; if (ginfo != NULL) { param_header_type = ginfo->type; } else { param_header_type = info->type; } send_parameter(name, (enum ap_var_type)param_header_type); } // Save the variable to EEPROM, if supported // bool AP_Param::save(bool force_save) { uint32_t group_element = 0; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info(&group_element, ginfo, ginfo0, &idx); const AP_Param *ap; if (info == NULL) { // we don't have any info on how to store it return false; } struct Param_header phdr; // create the header we will use to store the variable if (ginfo != NULL) { phdr.type = ginfo->type; } else { phdr.type = info->type; } set_key(phdr, info->key); phdr.group_element = group_element; ap = this; if (phdr.type != AP_PARAM_VECTOR3F && idx != 0) { // only vector3f can have non-zero idx for now return false; } if (idx != 0) { ap = (const AP_Param *)((ptrdiff_t)ap) - (idx*sizeof(float)); } char name[AP_MAX_NAME_SIZE+1]; copy_name_info(info, ginfo, ginfo0, idx, name, sizeof(name), true); // scan EEPROM to find the right location uint16_t ofs; if (scan(&phdr, &ofs)) { // found an existing copy of the variable eeprom_write_check(ap, ofs+sizeof(phdr), type_size((enum ap_var_type)phdr.type)); send_parameter(name, (enum ap_var_type)phdr.type); return true; } if (ofs == (uint16_t) ~0) { return false; } // if the value is the default value then don't save if (phdr.type <= AP_PARAM_FLOAT) { float v1 = cast_to_float((enum ap_var_type)phdr.type); float v2; if (ginfo != NULL) { v2 = get_default_value(&ginfo->def_value); } else { v2 = get_default_value(&info->def_value); } if (is_equal(v1,v2) && !force_save) { GCS_MAVLINK::send_parameter_value_all(name, (enum ap_var_type)info->type, v2); return true; } if (phdr.type != AP_PARAM_INT32 && (fabsf(v1-v2) < 0.0001f*fabsf(v1))) { // for other than 32 bit integers, we accept values within // 0.01 percent of the current value as being the same GCS_MAVLINK::send_parameter_value_all(name, (enum ap_var_type)info->type, v2); return true; } } if (ofs+type_size((enum ap_var_type)phdr.type)+2*sizeof(phdr) >= _storage.size()) { // we are out of room for saving variables hal.console->println("EEPROM full"); return false; } // write a new sentinal, then the data, then the header write_sentinal(ofs + sizeof(phdr) + type_size((enum ap_var_type)phdr.type)); eeprom_write_check(ap, ofs+sizeof(phdr), type_size((enum ap_var_type)phdr.type)); eeprom_write_check(&phdr, ofs, sizeof(phdr)); send_parameter(name, (enum ap_var_type)phdr.type); return true; } // Load the variable from EEPROM, if supported // bool AP_Param::load(void) { uint32_t group_element = 0; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info(&group_element, ginfo, ginfo0, &idx); if (info == NULL) { // we don't have any info on how to load it return false; } struct Param_header phdr; // create the header we will use to match the variable if (ginfo != NULL) { phdr.type = ginfo->type; } else { phdr.type = info->type; } set_key(phdr, info->key); phdr.group_element = group_element; // scan EEPROM to find the right location uint16_t ofs; if (!scan(&phdr, &ofs)) { // if the value isn't stored in EEPROM then set the default value if (ginfo != NULL) { ptrdiff_t base = (ptrdiff_t)info->ptr; set_value((enum ap_var_type)phdr.type, (void*)(base + ginfo->offset), get_default_value(&ginfo->def_value)); } else { set_value((enum ap_var_type)phdr.type, (void*)info->ptr, get_default_value(&info->def_value)); } return false; } if (phdr.type != AP_PARAM_VECTOR3F && idx != 0) { // only vector3f can have non-zero idx for now return false; } AP_Param *ap; ap = this; if (idx != 0) { ap = (AP_Param *)((ptrdiff_t)ap) - (idx*sizeof(float)); } // found it _storage.read_block(ap, ofs+sizeof(phdr), type_size((enum ap_var_type)phdr.type)); return true; } bool AP_Param::configured_in_storage(void) { uint32_t group_element = 0; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info(&group_element, ginfo, ginfo0, &idx); if (info == NULL) { // we don't have any info on how to load it return false; } struct Param_header phdr; // create the header we will use to match the variable if (ginfo != NULL) { phdr.type = ginfo->type; } else { phdr.type = info->type; } set_key(phdr, info->key); phdr.group_element = group_element; // scan EEPROM to find the right location uint16_t ofs; // only vector3f can have non-zero idx for now return scan(&phdr, &ofs) && (phdr.type == AP_PARAM_VECTOR3F || idx == 0); } bool AP_Param::configured_in_defaults_file(void) { uint32_t group_element = 0; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = find_var_info(&group_element, ginfo, ginfo0, &idx); if (info == NULL) { // we don't have any info on how to load it return false; } const float* def_value_ptr; if (ginfo != NULL) { def_value_ptr = &ginfo->def_value; } else { def_value_ptr = &info->def_value; } for (uint16_t i=0; iset(value); break; case AP_PARAM_INT16: ((AP_Int16 *)ptr)->set(value); break; case AP_PARAM_INT32: ((AP_Int32 *)ptr)->set(value); break; case AP_PARAM_FLOAT: ((AP_Float *)ptr)->set(value); break; default: break; } } // load default values for scalars in a group. This does not recurse // into other objects. This is a static function that should be called // in the objects constructor void AP_Param::setup_object_defaults(const void *object_pointer, const struct GroupInfo *group_info) { ptrdiff_t base = (ptrdiff_t)object_pointer; uint8_t type; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { if (type <= AP_PARAM_FLOAT) { void *ptr = (void *)(base + group_info[i].offset); set_value((enum ap_var_type)type, ptr, get_default_value(&group_info[i].def_value)); } } } // set a value directly in an object. This should only be used by // example code, not by mainline vehicle code void AP_Param::set_object_value(const void *object_pointer, const struct GroupInfo *group_info, const char *name, float value) { ptrdiff_t base = (ptrdiff_t)object_pointer; uint8_t type; for (uint8_t i=0; (type=group_info[i].type) != AP_PARAM_NONE; i++) { if (strcmp(name, group_info[i].name) == 0 && type <= AP_PARAM_FLOAT) { void *ptr = (void *)(base + group_info[i].offset); set_value((enum ap_var_type)type, ptr, value); } } } // load default values for all scalars in a sketch. This does not // recurse into sub-objects void AP_Param::setup_sketch_defaults(void) { setup(); for (uint16_t i=0; i<_num_vars; i++) { uint8_t type = _var_info[i].type; if (type <= AP_PARAM_FLOAT) { void *ptr = (void*)_var_info[i].ptr; set_value((enum ap_var_type)type, ptr, get_default_value(&_var_info[i].def_value)); } } } // Load all variables from EEPROM // bool AP_Param::load_all(void) { struct Param_header phdr; uint16_t ofs = sizeof(AP_Param::EEPROM_header); /* if the HAL specifies a defaults parameter file then override defaults using that file */ #ifdef HAL_PARAM_DEFAULTS_PATH load_defaults_file(HAL_PARAM_DEFAULTS_PATH); #endif while (ofs < _storage.size()) { _storage.read_block(&phdr, ofs, sizeof(phdr)); // note that this is an || not an && for robustness // against power off while adding a variable if (is_sentinal(phdr)) { // we've reached the sentinal return true; } const struct AP_Param::Info *info; void *ptr; info = find_by_header(phdr, &ptr); if (info != NULL) { _storage.read_block(ptr, ofs+sizeof(phdr), type_size((enum ap_var_type)phdr.type)); } ofs += type_size((enum ap_var_type)phdr.type) + sizeof(phdr); } // we didn't find the sentinal Debug("no sentinal in load_all"); return false; } /* Load all variables from EEPROM for a particular object. This is required for dynamically loaded objects */ void AP_Param::load_object_from_eeprom(const void *object_pointer, const struct GroupInfo *group_info) { struct Param_header phdr; ParamToken token; // find first storable value uint8_t i; for (i=0; group_info[i].type != AP_PARAM_NONE; i++) { if (group_info[i].type < AP_PARAM_GROUP) break; } if (group_info[i].type == AP_PARAM_NONE) { // no storable parameters return; } if (!find_by_pointer((AP_Param *)(((ptrdiff_t)object_pointer)+group_info[i].offset), token)) { hal.console->printf("ERROR: Unable to find param pointer\n"); return; } for (i=0; group_info[i].type != AP_PARAM_NONE; i++) { if (group_info[i].type == AP_PARAM_GROUP) { ptrdiff_t new_offset = 0; if (!adjust_group_offset(token.key, group_info[i], new_offset)) { continue; } load_object_from_eeprom((void *)(((ptrdiff_t)object_pointer)+new_offset), group_info[i].group_info); continue; } uint16_t ofs = sizeof(AP_Param::EEPROM_header); while (ofs < _storage.size()) { _storage.read_block(&phdr, ofs, sizeof(phdr)); // note that this is an || not an && for robustness // against power off while adding a variable if (is_sentinal(phdr)) { // we've reached the sentinal break; } if (get_key(phdr) == _var_info[token.key].key) { const struct AP_Param::Info *info; void *ptr; info = find_by_header(phdr, &ptr); if (info != NULL) { if ((ptrdiff_t)ptr == ((ptrdiff_t)object_pointer)+group_info[i].offset) { _storage.read_block(ptr, ofs+sizeof(phdr), type_size((enum ap_var_type)phdr.type)); break; } } } ofs += type_size((enum ap_var_type)phdr.type) + sizeof(phdr); } } } // return the first variable in _var_info AP_Param *AP_Param::first(ParamToken *token, enum ap_var_type *ptype) { token->key = 0; token->group_element = 0; token->idx = 0; if (_num_vars == 0) { return NULL; } if (ptype != NULL) { *ptype = (enum ap_var_type)_var_info[0].type; } return (AP_Param *)(_var_info[0].ptr); } /// Returns the next variable in a group, recursing into groups /// as needed AP_Param *AP_Param::next_group(uint16_t vindex, const struct GroupInfo *group_info, bool *found_current, uint8_t group_base, uint8_t group_shift, ptrdiff_t group_offset, ParamToken *token, enum ap_var_type *ptype) { enum ap_var_type type; for (uint8_t i=0; (type=(enum ap_var_type)group_info[i].type) != AP_PARAM_NONE; i++) { if (type == AP_PARAM_GROUP) { // a nested group const struct GroupInfo *ginfo = group_info[i].group_info; AP_Param *ap; ptrdiff_t new_offset = group_offset; if (!adjust_group_offset(vindex, group_info[i], new_offset)) { continue; } ap = next_group(vindex, ginfo, found_current, GROUP_ID(group_info, group_base, i, group_shift), group_shift + _group_level_shift, new_offset, token, ptype); if (ap != NULL) { return ap; } } else { if (*found_current) { // got a new one token->key = vindex; token->group_element = GROUP_ID(group_info, group_base, i, group_shift); token->idx = 0; if (ptype != NULL) { *ptype = type; } return (AP_Param*)((ptrdiff_t)_var_info[vindex].ptr + group_info[i].offset + group_offset); } if (GROUP_ID(group_info, group_base, i, group_shift) == token->group_element) { *found_current = true; if (type == AP_PARAM_VECTOR3F && token->idx < 3) { // return the next element of the vector as a // float token->idx++; if (ptype != NULL) { *ptype = AP_PARAM_FLOAT; } ptrdiff_t ofs = (ptrdiff_t)_var_info[vindex].ptr + group_info[i].offset + group_offset; ofs += sizeof(float)*(token->idx - 1u); return (AP_Param *)ofs; } } } } return NULL; } /// Returns the next variable in _var_info, recursing into groups /// as needed AP_Param *AP_Param::next(ParamToken *token, enum ap_var_type *ptype) { uint16_t i = token->key; bool found_current = false; if (i >= _num_vars) { // illegal token return NULL; } enum ap_var_type type = (enum ap_var_type)_var_info[i].type; // allow Vector3f to be seen as 3 variables. First as a vector, // then as 3 separate floats if (type == AP_PARAM_VECTOR3F && token->idx < 3) { token->idx++; if (ptype != NULL) { *ptype = AP_PARAM_FLOAT; } return (AP_Param *)(((token->idx - 1u)*sizeof(float))+(ptrdiff_t)_var_info[i].ptr); } if (type != AP_PARAM_GROUP) { i++; found_current = true; } for (; i<_num_vars; i++) { type = (enum ap_var_type)_var_info[i].type; if (type == AP_PARAM_GROUP) { const struct GroupInfo *group_info = _var_info[i].group_info; AP_Param *ap = next_group(i, group_info, &found_current, 0, 0, 0, token, ptype); if (ap != NULL) { return ap; } } else { // found the next one token->key = i; token->group_element = 0; token->idx = 0; if (ptype != NULL) { *ptype = type; } return (AP_Param *)(_var_info[i].ptr); } } return NULL; } /// Returns the next scalar in _var_info, recursing into groups /// as needed AP_Param *AP_Param::next_scalar(ParamToken *token, enum ap_var_type *ptype) { AP_Param *ap; enum ap_var_type type; while ((ap = next(token, &type)) != NULL && type > AP_PARAM_FLOAT) ; if (ap != NULL && type == AP_PARAM_INT8) { /* check if this is an enable variable. To do that we need to find the info structures for the variable */ uint32_t group_element; const struct GroupInfo *ginfo; const struct GroupInfo *ginfo0; uint8_t idx; const struct AP_Param::Info *info = ap->find_var_info_token(*token, &group_element, ginfo, ginfo0, &idx); if (info && ginfo && (ginfo->flags & AP_PARAM_FLAG_ENABLE) && ((AP_Int8 *)ap)->get() == 0) { /* this is a disabled parameter tree, include this parameter but not others below it. We need to keep looking until we go past the parameters in this object */ ParamToken token2 = *token; enum ap_var_type type2; AP_Param *ap2; while ((ap2 = next(&token2, &type2)) != NULL) { if (token2.key != token->key) { break; } if (ginfo0 != NULL && (token->group_element & 0x3F) != (token2.group_element & 0x3F)) { break; } // update the returned token so the next() call goes from this point *token = token2; } } } if (ap != NULL && ptype != NULL) { *ptype = type; } return ap; } /// cast a variable to a float given its type float AP_Param::cast_to_float(enum ap_var_type type) const { switch (type) { case AP_PARAM_INT8: return ((AP_Int8 *)this)->cast_to_float(); case AP_PARAM_INT16: return ((AP_Int16 *)this)->cast_to_float(); case AP_PARAM_INT32: return ((AP_Int32 *)this)->cast_to_float(); case AP_PARAM_FLOAT: return ((AP_Float *)this)->cast_to_float(); default: return NAN; } } // print the value of all variables void AP_Param::show(const AP_Param *ap, const char *s, enum ap_var_type type, AP_HAL::BetterStream *port) { switch (type) { case AP_PARAM_INT8: port->printf("%s: %d\n", s, (int)((AP_Int8 *)ap)->get()); break; case AP_PARAM_INT16: port->printf("%s: %d\n", s, (int)((AP_Int16 *)ap)->get()); break; case AP_PARAM_INT32: port->printf("%s: %ld\n", s, (long)((AP_Int32 *)ap)->get()); break; case AP_PARAM_FLOAT: port->printf("%s: %f\n", s, (double)((AP_Float *)ap)->get()); break; default: break; } } // print the value of all variables void AP_Param::show(const AP_Param *ap, const ParamToken &token, enum ap_var_type type, AP_HAL::BetterStream *port) { char s[AP_MAX_NAME_SIZE+1]; ap->copy_name_token(token, s, sizeof(s), true); s[AP_MAX_NAME_SIZE] = 0; show(ap, s, type, port); } // print the value of all variables void AP_Param::show_all(AP_HAL::BetterStream *port, bool showKeyValues) { ParamToken token; AP_Param *ap; enum ap_var_type type; for (ap=AP_Param::first(&token, &type); ap; ap=AP_Param::next_scalar(&token, &type)) { if (showKeyValues) { port->printf("Key %i: Index %i: GroupElement %i : ", token.key, token.idx, token.group_element); } show(ap, token, type, port); } } #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wformat" // convert one old vehicle parameter to new object parameter void AP_Param::convert_old_parameter(const struct ConversionInfo *info) { // find the old value in EEPROM. uint16_t pofs; AP_Param::Param_header header; header.type = info->type; set_key(header, info->old_key); header.group_element = info->old_group_element; if (!scan(&header, &pofs)) { // the old parameter isn't saved in the EEPROM. It was // probably still set to the default value, which isn't stored // no need to convert return; } // load the old value from EEPROM uint8_t old_value[type_size((enum ap_var_type)header.type)]; _storage.read_block(old_value, pofs+sizeof(header), sizeof(old_value)); const AP_Param *ap = (const AP_Param *)&old_value[0]; // find the new variable in the variable structures enum ap_var_type ptype; AP_Param *ap2; ap2 = find(&info->new_name[0], &ptype); if (ap2 == NULL) { hal.console->printf("Unknown conversion '%s'\n", info->new_name); return; } // see if we can load it from EEPROM if (ap2->load()) { // the new parameter already has a value set by the user, or // has already been converted return; } // see if they are the same type if (ptype == (ap_var_type)header.type) { // copy the value over only if the new parameter does not already // have the old value (via a default). if (memcmp(ap2, ap, sizeof(old_value)) != 0) { memcpy(ap2, ap, sizeof(old_value)); // and save ap2->save(); } } else if (ptype <= AP_PARAM_FLOAT && header.type <= AP_PARAM_FLOAT) { // perform scalar->scalar conversion float v = ap->cast_to_float((enum ap_var_type)header.type); if (!is_equal(v,ap2->cast_to_float(ptype))) { // the value needs to change set_value(ptype, ap2, v); ap2->save(); } } else { // can't do vector<->scalar conversion, or different vector types hal.console->printf("Bad conversion type '%s'\n", info->new_name); } } #pragma GCC diagnostic pop // convert old vehicle parameters to new object parametersv void AP_Param::convert_old_parameters(const struct ConversionInfo *conversion_table, uint8_t table_size) { for (uint8_t i=0; iset(value); } else if (var_type == AP_PARAM_INT32) { if (value < 0) rounding_addition = -rounding_addition; float v = value+rounding_addition; v = constrain_float(v, -2147483648.0, 2147483647.0); ((AP_Int32 *)this)->set(v); } else if (var_type == AP_PARAM_INT16) { if (value < 0) rounding_addition = -rounding_addition; float v = value+rounding_addition; v = constrain_float(v, -32768, 32767); ((AP_Int16 *)this)->set(v); } else if (var_type == AP_PARAM_INT8) { if (value < 0) rounding_addition = -rounding_addition; float v = value+rounding_addition; v = constrain_float(v, -128, 127); ((AP_Int8 *)this)->set(v); } } #if HAL_OS_POSIX_IO == 1 #include /* parse a parameter file line */ bool AP_Param::parse_param_line(char *line, char **vname, float &value) { if (line[0] == '#') { return false; } char *saveptr = NULL; char *pname = strtok_r(line, ", =\t", &saveptr); if (pname == NULL) { return false; } if (strlen(pname) > AP_MAX_NAME_SIZE) { return false; } const char *value_s = strtok_r(NULL, ", =\t", &saveptr); if (value_s == NULL) { return false; } value = atof(value_s); *vname = pname; return true; } /* load a default set of parameters from a file */ bool AP_Param::load_defaults_file(const char *filename) { FILE *f = fopen(filename, "r"); if (f == NULL) { return false; } char line[100]; /* work out how many parameter default structures to allocate */ uint16_t num_defaults = 0; while (fgets(line, sizeof(line)-1, f)) { char *pname; float value; if (!parse_param_line(line, &pname, value)) { continue; } if (!find_def_value_ptr(pname)) { fclose(f); ::printf("invalid param %s in defaults file\n", pname); AP_HAL::panic("AP_Param: Invalid param in defaults file"); return false; } num_defaults++; } fclose(f); if (param_overrides != NULL) { free(param_overrides); } num_param_overrides = 0; param_overrides = new param_override[num_defaults]; if (param_overrides == NULL) { AP_HAL::panic("AP_Param: Failed to allocate overrides"); return false; } /* re-open to avoid possible seek issues with NuttX */ f = fopen(filename, "r"); if (f == NULL) { AP_HAL::panic("AP_Param: Failed to re-open defaults file"); return false; } uint16_t idx = 0; while (fgets(line, sizeof(line)-1, f)) { char *pname; float value; if (!parse_param_line(line, &pname, value)) { continue; } const float *def_value_ptr = find_def_value_ptr(pname); if (!def_value_ptr) { fclose(f); AP_HAL::panic("AP_Param: Invalid param in defaults file"); return false; } param_overrides[idx].def_value_ptr = def_value_ptr; param_overrides[idx].value = value; idx++; enum ap_var_type var_type; AP_Param *vp = AP_Param::find(pname, &var_type); if (!vp) { fclose(f); AP_HAL::panic("AP_Param: Failed to set param default"); return false; } vp->set_float(value, var_type); } fclose(f); num_param_overrides = num_defaults; return true; } #endif // HAL_OS_POSIX_IO /* find a default value given a pointer to a default value in flash */ float AP_Param::get_default_value(const float *def_value_ptr) { for (uint16_t i=0; ix); name_axis = 'Y'; GCS_MAVLINK::send_parameter_value_all(name, AP_PARAM_FLOAT, v->y); name_axis = 'Z'; GCS_MAVLINK::send_parameter_value_all(name, AP_PARAM_FLOAT, v->z); }