1 РАЗРАБОТАН Акционерным обществом "Научно-производственное предприятие "Цифровые решения" (АО "НПП "Цифровые решения")

2 ВНЕСЕН Техническим комитетом по стандартизации ТК 303 "Электронная компонентная база, материалы и оборудование"

3 УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Приказом Федерального агентства по техническому регулированию и метрологии от 9 ноября 2023 г. N 1370-ст

4 ВВЕДЕН ВПЕРВЫЕ

Настоящий стандарт распространяется на сложно-функциональные блоки (далее - СФ-блоки), применяемые при разработке интегральных микросхем.

Настоящий стандарт устанавливает требования к построению, содержанию, изложению и оформлению руководства по программированию СФ-блока.

При необходимости требования, установленные в настоящем стандарте, могут быть конкретизированы в стандартах и/или иных документах разработчика СФ-блока.

В настоящем стандарте использованы нормативные ссылки на следующие стандарты:

ГОСТ 2.701 Единая система конструкторской документации. Схемы. Виды и типы. Общие требования к выполнению

ГОСТ Р 2.105 Единая система конструкторской документации. Общие требования к текстовым документам

ГОСТ Р 55386 Интеллектуальная собственность. Термины и определения

ГОСТ Р 57435 Микросхемы интегральные. Термины и определения

ГОСТ Р 70916 Блоки сложно-функциональные. Термины и определения

Примечание - При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов в информационной системе общего пользования - на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет или по ежегодному информационному указателю "Национальные стандарты", который опубликован по состоянию на 1 января текущего года, и по выпускам ежемесячного информационного указателя "Национальные стандарты" за текущий год. Если заменен ссылочный стандарт, на который дана недатированная ссылка, то рекомендуется использовать действующую версию этого стандарта с учетом всех внесенных в данную версию изменений. Если заменен ссылочный стандарт, на который дана датированная ссылка, то рекомендуется использовать версию этого стандарта с указанным выше годом утверждения (принятия). Если после утверждения настоящего стандарта в ссылочный стандарт, на который дана датированная ссылка, внесено изменение, затрагивающее положение, на которое дана ссылка, то это положение рекомендуется применять без учета данного изменения. Если ссылочный стандарт отменен без замены, то положение, в котором дана ссылка на него, рекомендуется применять в части, не затрагивающей эту ссылку.

В настоящем стандарте применены термины по ГОСТ 2.701, ГОСТ Р 55386, ГОСТ Р 57435, ГОСТ Р 70916, а также следующие термины с соответствующими определениями:

3.1 (битовое) поле: Абстрактное представление аппаратного элемента хранения данных.

3.2 регистр: Набор из одного или более битовых полей.

4.1 Руководство по программированию является документом, содержащим сведения о взаимодействии СФ-блока с программным обеспечением.

4.2 Руководство по программированию следует разрабатывать на один конкретный СФ-блок или на множество однотипных СФ-блоков.

4.3 В руководстве по программированию требования, приведенные в соответствующих межгосударственных и национальных стандартах, повторять не следует, данные требования заменяют ссылками на эти стандарты.

4.4 Общее оформление титульного листа, заголовков, текста, приложений, перечислений, таблиц, графического материала, формул, ссылок, примечаний, примеров, единиц величин и числовых значений рекомендуется выполнять согласно требованиям ГОСТ Р 2.105.

4.5 Руководство по программированию может быть выполнено в бумажной и/или электронной форме (на бумажных и/или электронных носителях).

4.6 В руководстве по программированию не допускается двусмысленность информации, а именно:

- руководство по программированию должно быть сформулировано точно и понятно для квалифицированного персонала;

- последовательность выполняемых действий должна быть однозначной;

- риски и запреты должны быть точно сформулированы и изложены.

4.7 Если для СФ-блока неприменима операция программирования, руководство по программированию в комплект документации на СФ-блок не включают.

5.1.1 Руководство по программированию должно содержать введение и разделы, расположенные в следующей последовательности:

- карта регистров;

- описание регистров;

- инструкция по программированию.

5.1.1.1 При необходимости руководство по программированию может быть дополнено другими разделами (подразделами), в зависимости от типа и особенностей СФ-блока.

5.1.1.2 Если карты регистров составляются на группы (блоки) регистров, описание регистров соответствующей группы (блока) рекомендуется приводить непосредственно после их карты. В этом случае вместо разделов "Карта регистров" и "Описание регистров" вводятся разделы "Карта регистров группы (блока) ..." и "Описание регистров группы (блока) ...".

5.1.1.3 Отсутствие требований, ограничений или рекомендаций ввиду особенностей СФ-блока должно быть явно и однозначно отражено в содержании раздела (подраздела).

5.1.1.4 Допускается в наименованиях разделов (подразделов) заменять сокращение "СФ-блок" на наименование СФ-блока.

5.1.2 Допускается включать руководство по программированию в состав руководства пользователя СФ-блока в качестве дополнительного раздела в случае, если объем документа не превышает 20 страниц.

5.2.1 Допускается включать во введение информацию о разработчике СФ-блока.

5.2.2 Допускается включать во введение информацию о защите интеллектуальной собственности.

5.2.3 Рекомендуется включать во введение заявление об освобождении от ответственности в случае несоблюдения требований руководства по программированию.

5.3.1 Раздел "Карта регистров" должен содержать перечень регистров, доступных программному обеспечению, и соответствующие регистрам адреса (абсолютные или смещения относительно базового адреса), а также краткие сведения о назначении регистров (описание).

5.3.1.1 Рекомендуется включать в раздел "Карта регистров" общие сведения о регистрах: ширина, тип доступа, тип интерфейса по которому осуществляется доступ.

5.3.2 Перечень регистров, краткие сведения о назначении регистров и соответствующие регистрам адреса следует приводить как показано в таблице 1.

5.3.3 При необходимости, в зависимости от типа и особенностей СФ-блока, в таблицу допускается вводить дополнительные графы перед графой "Описание".

5.4.1 Раздел "Описание регистров" должен содержать описание всех регистров СФ-блока, взаимодействующих с программным обеспечением.

5.4.1.1 Сведения о регистре СФ-блока должны содержать название регистра, адрес, поля (номера битов), названия полей, тип доступа, значения после сброса и описание.

5.4.1.2 Допускается группировать описания регистров СФ-блока.

5.4.2 Описание регистра WdogControl 0x00001200 СФ-блока следует приводить в соответствии с таблицей 2.

5.4.2.1 Поля в описании регистра должны идти от старшего бита к младшему.

5.4.2.2 Для заполнения поля "Тип доступа" вводят следующие обозначения наименований базовых операций и префиксов к ним:

- Ч - чтение;

- З - запись;

- 0 - читается/записывается только 0;

- 1 - читается/записывается только 1;

- С - во время операции выполняется сброс значения;

- А - выполняется автоматический сброс значения аппаратной частью.

Примечание - Возможна комбинация разных режимов чтения и записи.

5.4.2.3 К шестнадцатеричным значениям следует добавлять префикс 0x, к бинарным значениям добавлять префикс 0b, к десятичным значениям префикс не добавляется.

5.4.2.4 Расширенную информацию, дополнительные расшифровки и примечания к описанию работы регистров рекомендуется приводить в сносках после таблицы с описанием регистров.

5.4.3 При необходимости в зависимости от типа и особенностей СФ-блока в таблицу допускается вводить дополнительные графы перед графой "Описание".

5.5.1 Раздел "Инструкция по программированию" должен содержать описание процедур программирования СФ-блока для выполнения функционала, описанного в руководстве пользователя.

5.5.1.1 Раздел должен содержать описание поддерживаемых СФ-блоком режимов работы и описание процедур программирования для изменения режимов работы СФ-блока.

5.5.1.2 Раздел должен содержать описание процедур программирования регистров СФ-блока.

5.5.1.3 Допускается приводить в разделе алгоритмические блок-схемы, временные диаграммы и структурные электрические схемы для описания процедур программирования.

5.5.1.4 Раздел дополнительно может содержать описание программной части тестового окружения, входящего в комплект поставки СФ-блока.