Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding explanation and changing name of personalize.py #189

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

dehanj
Copy link
Member

@dehanj dehanj commented Mar 21, 2024

Changed filename in order to be a bit less cryptic about what the python script does.
Also adding a more detailed explanation about what it intends to do.

@dehanj dehanj requested a review from mchack-work March 21, 2024 12:49
@dehanj dehanj changed the title Adding explanation to personalize.py Adding explanation and changing name of personalize.py Mar 21, 2024
@dehanj dehanj force-pushed the script_explaination branch from 6ee9a55 to d97f27f Compare March 21, 2024 13:34
@secworks
Copy link
Contributor

secworks commented Mar 25, 2024

I prefer the old name (though not the description in the hader). The use case is to create a unique TKey (i.e. personalize it) by generating unique UDS and UDI. Patching is just how these unique fields are put into the design.

I have no problem with tools that have names longer than three letters. 'personalize_uds_udi.py', 'gen_unique_tkey.py' 'gen_udi_uds.py' are some ideas of names that reflect what the tool does.

@dehanj
Copy link
Member Author

dehanj commented Mar 25, 2024

I prefer the old name (though not the description in the header). The use case is to create a unique TKey (i.e. personalize it) by generating unique UDS and UDI. Patching is just how these unique fields are put into the design.

While I agree, I also disagree with the use case you mention.

The use case of this particular script is to simply patch your already personalized (hopefully) UDS or UDI.
This tool does not make sure you have personalized anything, nor does it change the already set UDS or UDI. it simple takes some data and patch it into another file, hence the choice of the filename.

To personalize your UDS and UDI your are using tpt.py, (Tillitis Provisioning Tool), and this tool to actually put it in the bitstream - so a both of them achieves a personalization according to me. Or you simpy update the uds.hex and udi.hex by yourself.

So I actually think it is a bit misleading and might give false hopes that all you need to do to get a unique UDS and UDI is to run this tool, which is not true.

@secworks
Copy link
Contributor

Ah, I'm mixing up tpt with personalize.py. Then i totally agree with the new name.

@dehanj
Copy link
Member Author

dehanj commented Mar 26, 2024

I think the changes look good, but suggest we squash all the commits.

@mchack-work mchack-work force-pushed the script_explaination branch from 6834b7c to bf9171f Compare March 26, 2024 12:00
Copy link
Member

@mchack-work mchack-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would like more explanation of how it all fits together but might not need it here.

Tested building. Works fine.

Also adding a more detailed explaination of what the script intends to
do
@mchack-work mchack-work force-pushed the script_explaination branch from bf9171f to c85b531 Compare March 26, 2024 12:08
@mchack-work mchack-work merged commit c85b531 into main Mar 26, 2024
1 check passed
@mchack-work mchack-work deleted the script_explaination branch March 26, 2024 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants